Add "Mailing List" users

Summary:
Ref T8387. Adds new mailing list users.

This doesn't migrate anything yet. I also need to update the "Email Addresses" panel to let administrators change the list address.

Test Plan:
- Created and edited a mailing list user.
- Viewed profile.
- Viewed People list.
- Searched for lists / nonlists.
- Grepped for all uses of `getIsDisabled()` / `getIsSystemAgent()` and added relevant corresponding behaviors.
- Hit the web/api/ssh session blocks.

Reviewers: btrahan

Reviewed By: btrahan

Subscribers: eadler, tycho.tatitscheff, epriestley

Maniphest Tasks: T8387

Differential Revision: https://secure.phabricator.com/D13123

resources/sql/autopatches/20150602.mlist.1.sql

···
+ALTER TABLE {$NAMESPACE}_user.user
+  ADD isMailingList BOOL NOT NULL;

scripts/ssh/ssh-exec.php

···
       'P' => $user->getPHID(),
     ));
 
-  if (!$user->isUserActivated()) {
+  if (!$user->canEstablishSSHSessions()) {
     throw new Exception(
       pht(
-        'Your account ("%s") is not activated. Visit the web interface '.
-        'for more information.',
+        'Your account ("%s") does not have permission to establish SSH '.
+        'sessions. Visit the web interface for more information.',
         $user->getUsername()));
   }
 

scripts/user/account_admin.php

···
 
 $is_system_agent = $user->getIsSystemAgent();
 $set_system_agent = phutil_console_confirm(
-  pht('Is this user a bot/script?'),
+  pht('Is this user a bot?'),
   $default_no = !$is_system_agent);
 
 $verify_email = null;
···
 
 printf(
   $tpl,
-  pht('Bot/Script'),
+  pht('Bot'),
   $original->getIsSystemAgent() ? 'Y' : 'N',
   $set_system_agent ? 'Y' : 'N');
 

src/applications/auth/engine/PhabricatorAuthSessionEngine.php

···
         $session_dict[substr($key, 2)] = $value;
       }
     }
+
+    $user = $user_table->loadFromArray($info);
+    switch ($session_type) {
+      case PhabricatorAuthSession::TYPE_WEB:
+        // Explicitly prevent bots and mailing lists from establishing web
+        // sessions. It's normally impossible to attach authentication to these
+        // accounts, and likewise impossible to generate sessions, but it's
+        // technically possible that a session could exist in the database. If
+        // one does somehow, refuse to load it.
+        if (!$user->canEstablishWebSessions()) {
+          return null;
+        }
+        break;
+    }
+
     $session = id(new PhabricatorAuthSession())->loadFromArray($session_dict);
 
     $ttl = PhabricatorAuthSession::getSessionTypeTTL($session_type);
···
       unset($unguarded);
     }
 
-    $user = $user_table->loadFromArray($info);
     $user->attachSession($session);
     return $user;
   }

src/applications/conduit/controller/PhabricatorConduitAPIController.php

···
     ConduitAPIRequest $request,
     PhabricatorUser $user) {
 
-    if (!$user->isUserActivated()) {
+    if (!$user->canEstablishAPISessions()) {
       return array(
-        'ERR-USER-DISABLED',
-        pht('User account is not activated.'),
+        'ERR-INVALID-AUTH',
+        pht('User account is not permitted to use the API.'),
       );
     }
 

src/applications/conduit/settings/PhabricatorConduitTokensSettingsPanel.php

···
   }
 
   public function isEnabled() {
+    if ($this->getUser()->getIsMailingList()) {
+      return false;
+    }
+
     return true;
   }
 

src/applications/diffusion/panel/DiffusionSetPasswordSettingsPanel.php

···
   }
 
   public function isEnabled() {
+    if ($this->getUser()->getIsMailingList()) {
+      return false;
+    }
+
     return PhabricatorEnv::getEnvConfig('diffusion.allow-http-auth');
   }
 

src/applications/people/conduit/UserConduitAPIMethod.php

···
     if ($user->getIsSystemAgent()) {
       $roles[] = 'agent';
     }
+    if ($user->getIsMailingList()) {
+      $roles[] = 'list';
+    }
     if ($user->getIsAdmin()) {
       $roles[] = 'admin';
     }

src/applications/people/controller/PhabricatorPeopleCreateController.php

···
   extends PhabricatorPeopleController {
 
   public function handleRequest(AphrontRequest $request) {
-    $this->requireApplicationCapability(
-      PeopleCreateUsersCapability::CAPABILITY);
     $admin = $request->getUser();
 
     id(new PhabricatorAuthSessionEngine())->requireHighSecuritySession(
···
     if ($request->isFormPost()) {
       $v_type = $request->getStr('type');
 
-      if ($v_type == 'standard' || $v_type == 'bot') {
+      if ($v_type == 'standard' || $v_type == 'bot' || $v_type == 'list') {
         return id(new AphrontRedirectResponse())->setURI(
           $this->getApplicationURI('new/'.$v_type.'/'));
       }
···
     $bot_admin = pht(
       'Administrators have greater access to edit these accounts.');
 
+    $types = array();
+
+    $can_create = $this->hasApplicationCapability(
+      PeopleCreateUsersCapability::CAPABILITY);
+    if ($can_create) {
+      $types[] = array(
+        'type' => 'standard',
+        'name' => pht('Create Standard User'),
+        'help' => pht('Create a standard user account.'),
+      );
+    }
+
+    $types[] = array(
+      'type' => 'bot',
+      'name' => pht('Create Bot User'),
+      'help' => pht('Create a new user for use with automated scripts.'),
+    );
+
+    $types[] = array(
+      'type' => 'list',
+      'name' => pht('Create Mailing List User'),
+      'help' => pht(
+        'Create a mailing list user to represent an existing, external '.
+        'mailing list like a Google Group or a Mailman list.'),
+    );
+
+    $buttons = id(new AphrontFormRadioButtonControl())
+      ->setLabel(pht('Account Type'))
+      ->setName('type')
+      ->setValue($v_type);
+
+    foreach ($types as $type) {
+      $buttons->addButton($type['type'], $type['name'], $type['help']);
+    }
+
     $form = id(new AphrontFormView())
       ->setUser($admin)
       ->appendRemarkupInstructions(
···
           'explanation of user account types, see [[ %s | User Guide: '.
           'Account Roles ]].',
           PhabricatorEnv::getDoclink('User Guide: Account Roles')))
-      ->appendChild(
-        id(new AphrontFormRadioButtonControl())
-          ->setLabel(pht('Account Type'))
-          ->setName('type')
-          ->setValue($v_type)
-          ->addButton(
-            'standard',
-            pht('Create Standard User'),
-            hsprintf('%s<br /><br />%s', $standard_caption, $standard_admin))
-          ->addButton(
-            'bot',
-            pht('Create Bot/Script User'),
-            hsprintf('%s<br /><br />%s', $bot_caption, $bot_admin)))
+      ->appendChild($buttons)
       ->appendChild(
         id(new AphrontFormSubmitControl())
           ->addCancelButton($this->getApplicationURI())

src/applications/people/controller/PhabricatorPeopleListController.php

···
     $crumbs = parent::buildApplicationCrumbs();
     $viewer = $this->getRequest()->getUser();
 
-    $can_create = $this->hasApplicationCapability(
-      PeopleCreateUsersCapability::CAPABILITY);
-    if ($can_create) {
+    if ($viewer->getIsAdmin()) {
       $crumbs->addAction(
         id(new PHUIListItemView())
         ->setName(pht('Create New User'))
         ->setHref($this->getApplicationURI('create/'))
-        ->setIcon('fa-plus-square'));
-    } else if ($viewer->getIsAdmin()) {
-      $crumbs->addAction(
-        id(new PHUIListItemView())
-        ->setName(pht('Create New Bot'))
-        ->setHref($this->getApplicationURI('new/bot/'))
         ->setIcon('fa-plus-square'));
     }
 

src/applications/people/controller/PhabricatorPeopleNewController.php

···
     $type = $request->getURIData('type');
     $admin = $request->getUser();
 
+    $is_bot = false;
+    $is_list = false;
     switch ($type) {
       case 'standard':
         $this->requireApplicationCapability(
           PeopleCreateUsersCapability::CAPABILITY);
-        $is_bot = false;
         break;
       case 'bot':
         $is_bot = true;
+        break;
+      case 'list':
+        $is_list = true;
         break;
       default:
         return new Aphront404Response();
···
           // Automatically approve the user, since an admin is creating them.
           $user->setIsApproved(1);
 
-          // If the user is a bot, approve their email too.
-          if ($is_bot) {
+          // If the user is a bot or list, approve their email too.
+          if ($is_bot || $is_list) {
             $email->setIsVerified(1);
           }
 
···
               ->makeSystemAgentUser($user, true);
           }
 
-          if ($welcome_checked && !$is_bot) {
+          if ($is_list) {
+            id(new PhabricatorUserEditor())
+              ->setActor($admin)
+              ->makeMailingListUser($user, true);
+          }
+
+          if ($welcome_checked && !$is_bot && !$is_list) {
             $user->sendWelcomeEmail($admin);
           }
 
···
 
     if ($is_bot) {
       $form->appendRemarkupInstructions(
-        pht('You are creating a new **bot/script** user account.'));
+        pht('You are creating a new **bot** user account.'));
+    } else if ($is_list) {
+      $form->appendRemarkupInstructions(
+        pht('You are creating a new **mailing list** user account.'));
     } else {
       $form->appendRemarkupInstructions(
         pht('You are creating a new **standard** user account.'));
···
           ->setCaption(PhabricatorUserEmail::describeAllowedAddresses())
           ->setError($e_email));
 
-    if (!$is_bot) {
+    if (!$is_bot && !$is_list) {
       $form->appendChild(
         id(new AphrontFormCheckboxControl())
           ->addCheckbox(
···
         ->appendChild(id(new AphrontFormDividerControl()))
         ->appendRemarkupInstructions(
           pht(
-            '**Why do bot/script accounts need an email address?**'.
+            '**Why do bot accounts need an email address?**'.
             "\n\n".
             'Although bots do not normally receive email from Phabricator, '.
             'they can interact with other systems which require an email '.

src/applications/people/customfield/PhabricatorUserRolesField.php

···
     if ($user->getIsSystemAgent()) {
       $roles[] = pht('Bot');
     }
+    if ($user->getIsMailingList()) {
+      $roles[] = pht('Mailing List');
+    }
 
     if ($roles) {
       return implode(', ', $roles);

src/applications/people/editor/PhabricatorUserEditor.php

···
     return $this;
   }
 
+  /**
+   * @task role
+   */
+  public function makeMailingListUser(PhabricatorUser $user, $mailing_list) {
+    $actor = $this->requireActor();
+
+    if (!$user->getID()) {
+      throw new Exception(pht('User has not been created yet!'));
+    }
+
+    $user->openTransaction();
+      $user->beginWriteLocking();
+
+        $user->reload();
+        if ($user->getIsMailingList() == $mailing_list) {
+          $user->endWriteLocking();
+          $user->killTransaction();
+          return $this;
+        }
+
+        $log = PhabricatorUserLog::initializeNewLog(
+          $actor,
+          $user->getPHID(),
+          PhabricatorUserLog::ACTION_MAILING_LIST);
+        $log->setOldValue($user->getIsMailingList());
+        $log->setNewValue($mailing_list);
+
+        $user->setIsMailingList((int)$mailing_list);
+        $user->save();
+
+        $log->save();
+
+      $user->endWriteLocking();
+    $user->saveTransaction();
+
+    return $this;
+  }
 
   /**
    * @task role

src/applications/people/phid/PhabricatorPeopleUserPHIDType.php

···
       $handle->setFullName($user->getFullName());
       $handle->setImageURI($user->getProfileImageURI());
 
+      if ($user->getIsMailingList()) {
+        $handle->setIcon('fa-envelope-o');
+      }
+
       $availability = null;
       if (!$user->isUserActivated()) {
         $availability = PhabricatorObjectHandle::AVAILABILITY_DISABLED;

src/applications/people/query/PhabricatorPeopleQuery.php

···
   private $dateCreatedBefore;
   private $isAdmin;
   private $isSystemAgent;
+  private $isMailingList;
   private $isDisabled;
   private $isApproved;
   private $nameLike;
···
 
   public function withIsSystemAgent($system_agent) {
     $this->isSystemAgent = $system_agent;
+    return $this;
+  }
+
+  public function withIsMailingList($mailing_list) {
+    $this->isMailingList = $mailing_list;
     return $this;
   }
 
···
         $conn_r,
         'user.isSystemAgent = %d',
         (int)$this->isSystemAgent);
+    }
+
+    if ($this->isMailingList !== null) {
+      $where[] = qsprintf(
+        $conn_r,
+        'user.isMailingList = %d',
+        (int)$this->isMailingList);
     }
 
     if (strlen($this->nameLike)) {

src/applications/people/query/PhabricatorPeopleSearchEngine.php

···
       $this->readBoolFromRequest($request, 'isSystemAgent'));
 
     $saved->setParameter(
+      'isMailingList',
+      $this->readBoolFromRequest($request, 'isMailingList'));
+
+    $saved->setParameter(
       'needsApproval',
       $this->readBoolFromRequest($request, 'needsApproval'));
 
···
     $is_admin = $saved->getParameter('isAdmin');
     $is_disabled = $saved->getParameter('isDisabled');
     $is_system_agent = $saved->getParameter('isSystemAgent');
+    $is_mailing_list = $saved->getParameter('isMailingList');
     $needs_approval = $saved->getParameter('needsApproval');
 
     if ($is_admin !== null) {
···
       $query->withIsSystemAgent($is_system_agent);
     }
 
+    if ($is_mailing_list !== null) {
+      $query->withIsMailingList($is_mailing_list);
+    }
+
     if ($needs_approval !== null) {
       $query->withIsApproved(!$needs_approval);
     }
···
     $is_admin = $this->getBoolFromQuery($saved, 'isAdmin');
     $is_disabled = $this->getBoolFromQuery($saved, 'isDisabled');
     $is_system_agent = $this->getBoolFromQuery($saved, 'isSystemAgent');
+    $is_mailing_list = $this->getBoolFromQuery($saved, 'isMailingList');
     $needs_approval = $this->getBoolFromQuery($saved, 'needsApproval');
 
     $form
···
             )))
       ->appendChild(
         id(new AphrontFormSelectControl())
+          ->setName('isMailingList')
+          ->setLabel(pht('Mailing Lists'))
+          ->setValue($is_mailing_list)
+          ->setOptions(
+            array(
+              '' => pht('(Show All)'),
+              'true' => pht('Show Only Mailing Lists'),
+              'false' => pht('Hide Mailing Lists'),
+            )))
+      ->appendChild(
+        id(new AphrontFormSelectControl())
           ->setName('needsApproval')
           ->setLabel(pht('Needs Approval'))
           ->setValue($needs_approval)
···
 
       if ($user->getIsSystemAgent()) {
         $item->addIcon('fa-desktop', pht('Bot'));
+      }
+
+      if ($user->getIsMailingList()) {
+        $item->addIcon('fa-envelope-o', pht('Mailing List'));
       }
 
       if ($viewer->getIsAdmin()) {

src/applications/people/storage/PhabricatorUser.php

···
   protected $conduitCertificate;
 
   protected $isSystemAgent = 0;
+  protected $isMailingList = 0;
   protected $isAdmin = 0;
   protected $isDisabled = 0;
   protected $isEmailVerified = 0;
···
         return (bool)$this->isDisabled;
       case 'isSystemAgent':
         return (bool)$this->isSystemAgent;
+      case 'isMailingList':
+        return (bool)$this->isMailingList;
       case 'isEmailVerified':
         return (bool)$this->isEmailVerified;
       case 'isApproved':
···
     return true;
   }
 
+  public function canEstablishWebSessions() {
+    if (!$this->isUserActivated()) {
+      return false;
+    }
+
+    if ($this->getIsMailingList()) {
+      return false;
+    }
+
+    if ($this->getIsSystemAgent()) {
+      return false;
+    }
+
+    return true;
+  }
+
+  public function canEstablishAPISessions() {
+    if (!$this->isUserActivated()) {
+      return false;
+    }
+
+    if ($this->getIsMailingList()) {
+      return false;
+    }
+
+    return true;
+  }
+
+  public function canEstablishSSHSessions() {
+    if (!$this->isUserActivated()) {
+      return false;
+    }
+
+    if ($this->getIsMailingList()) {
+      return false;
+    }
+
+    return true;
+  }
+
   /**
    * Returns `true` if this is a standard user who is logged in. Returns `false`
    * for logged out, anonymous, or external users.
···
         'consoleTab' => 'text64',
         'conduitCertificate' => 'text255',
         'isSystemAgent' => 'bool',
+        'isMailingList' => 'bool',
         'isDisabled' => 'bool',
         'isAdmin' => 'bool',
         'timezoneIdentifier' => 'text255',
···
       case PhabricatorPolicyCapability::CAN_VIEW:
         return PhabricatorPolicies::POLICY_PUBLIC;
       case PhabricatorPolicyCapability::CAN_EDIT:
-        if ($this->getIsSystemAgent()) {
+        if ($this->getIsSystemAgent() || $this->getIsMailingList()) {
           return PhabricatorPolicies::POLICY_ADMIN;
         } else {
           return PhabricatorPolicies::POLICY_NOONE;

src/applications/people/storage/PhabricatorUserLog.php

···
 
   const ACTION_ADMIN          = 'admin';
   const ACTION_SYSTEM_AGENT   = 'system-agent';
+  const ACTION_MAILING_LIST   = 'mailing-list';
   const ACTION_DISABLE        = 'disable';
   const ACTION_APPROVE        = 'approve';
   const ACTION_DELETE         = 'delete';
···
       self::ACTION_EDIT => pht('Edit Account'),
       self::ACTION_ADMIN => pht('Add/Remove Administrator'),
       self::ACTION_SYSTEM_AGENT => pht('Add/Remove System Agent'),
+      self::ACTION_MAILING_LIST => pht('Add/Remove Mailing List'),
       self::ACTION_DISABLE => pht('Enable/Disable'),
       self::ACTION_APPROVE => pht('Approve Registration'),
       self::ACTION_DELETE => pht('Delete User'),

src/applications/people/typeahead/PhabricatorPeopleDatasource.php

···
       if ($user->getIsDisabled()) {
         $closed = pht('Disabled');
       } else if ($user->getIsSystemAgent()) {
-        $closed = pht('Bot/Script');
+        $closed = pht('Bot');
+      } else if ($user->getIsMailingList()) {
+        $closed = pht('Mailing List');
       }
 
       $result = id(new PhabricatorTypeaheadResult())
···
         ->setPriorityString($user->getUsername())
         ->setPriorityType('user')
         ->setClosed($closed);
+
+      if ($user->getIsMailingList()) {
+        $result->setIcon('fa-envelope-o');
+      }
 
       if ($this->enrichResults) {
         $display_type = 'User';

src/applications/settings/controller/PhabricatorSettingsMainController.php

···
 
     $result = array();
     foreach ($panels as $key => $panel) {
+      $panel->setUser($this->user);
+
       if (!$panel->isEnabled()) {
         continue;
       }

src/applications/settings/panel/PhabricatorConduitCertificateSettingsPanel.php

···
     return pht('Authentication');
   }
 
+  public function isEnabled() {
+    if ($this->getUser()->getIsMailingList()) {
+      return false;
+    }
+
+    return true;
+  }
+
   public function processRequest(AphrontRequest $request) {
     $user = $this->getUser();
     $viewer = $request->getUser();

src/applications/settings/panel/PhabricatorSSHKeysSettingsPanel.php

···
   }
 
   public function isEnabled() {
+    if ($this->getUser()->getIsMailingList()) {
+      return false;
+    }
+
     return true;
   }