Project - add ability to select an icon for typeaheads and such

Summary: Fixes T5090. Introduced getIcon into Handle stack which allows you to specify a per handle icon. getIcon falls back ot getTypeIcon.

Test Plan: changed the icon on a project a bunch. verified transactions showed up. verified icon showed up in typeahead. verified icon showed up in tokens that were pre-generated (not typed in). units test passed.

Reviewers: chad, epriestley

Reviewed By: epriestley

Subscribers: epriestley, Korvin

Maniphest Tasks: T5090

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

resources/celerity/map.php

···
     'rsrc/css/application/ponder/post.css' => 'ebab8a70',
     'rsrc/css/application/ponder/vote.css' => '8ed6ed8b',
     'rsrc/css/application/profile/profile-view.css' => '33e6f703',
+    'rsrc/css/application/projects/project-icon.css' => 'd80f48b0',
     'rsrc/css/application/projects/project-tag.css' => '095c9404',
     'rsrc/css/application/releeph/releeph-core.css' => '9b3c5733',
     'rsrc/css/application/releeph/releeph-preview-branch.css' => 'b7a6f4a5',
···
     'ponder-feed-view-css' => 'e62615b6',
     'ponder-post-css' => 'ebab8a70',
     'ponder-vote-css' => '8ed6ed8b',
+    'project-icon-css' => 'd80f48b0',
     'raphael-core' => '51ee6b43',
     'raphael-g' => '40dde778',
     'raphael-g-line' => '40da039e',

resources/sql/autopatches/20140522.projecticon.sql

···
+ALTER TABLE {$NAMESPACE}_project.project
+  ADD COLUMN icon VARCHAR(32) NOT NULL COLLATE utf8_bin;
+
+UPDATE {$NAMESPACE}_project.project
+  SET icon = "fa-briefcase" WHERE icon = "";

src/__phutil_library_map__.php

···
     'PhabricatorProjectDAO' => 'applications/project/storage/PhabricatorProjectDAO.php',
     'PhabricatorProjectDescriptionField' => 'applications/project/customfield/PhabricatorProjectDescriptionField.php',
     'PhabricatorProjectEditDetailsController' => 'applications/project/controller/PhabricatorProjectEditDetailsController.php',
+    'PhabricatorProjectEditIconController' => 'applications/project/controller/PhabricatorProjectEditIconController.php',
     'PhabricatorProjectEditMainController' => 'applications/project/controller/PhabricatorProjectEditMainController.php',
     'PhabricatorProjectEditPictureController' => 'applications/project/controller/PhabricatorProjectEditPictureController.php',
     'PhabricatorProjectEditorTestCase' => 'applications/project/editor/__tests__/PhabricatorProjectEditorTestCase.php',
+    'PhabricatorProjectIcon' => 'applications/project/icon/PhabricatorProjectIcon.php',
     'PhabricatorProjectListController' => 'applications/project/controller/PhabricatorProjectListController.php',
     'PhabricatorProjectMembersEditController' => 'applications/project/controller/PhabricatorProjectMembersEditController.php',
     'PhabricatorProjectMembersRemoveController' => 'applications/project/controller/PhabricatorProjectMembersRemoveController.php',
···
     'PhabricatorProjectDAO' => 'PhabricatorLiskDAO',
     'PhabricatorProjectDescriptionField' => 'PhabricatorProjectStandardCustomField',
     'PhabricatorProjectEditDetailsController' => 'PhabricatorProjectController',
+    'PhabricatorProjectEditIconController' => 'PhabricatorProjectController',
     'PhabricatorProjectEditMainController' => 'PhabricatorProjectController',
     'PhabricatorProjectEditPictureController' => 'PhabricatorProjectController',
     'PhabricatorProjectEditorTestCase' => 'PhabricatorTestCase',
+    'PhabricatorProjectIcon' => 'Phobject',
     'PhabricatorProjectListController' => 'PhabricatorProjectController',
     'PhabricatorProjectMembersEditController' => 'PhabricatorProjectController',
     'PhabricatorProjectMembersRemoveController' => 'PhabricatorProjectController',

src/applications/phid/PhabricatorObjectHandle.php

···
   private $fullName;
   private $title;
   private $imageURI;
+  private $icon;
   private $timestamp;
   private $status = PhabricatorObjectHandleStatus::STATUS_OPEN;
   private $complete;
   private $disabled;
   private $objectName;
   private $policyFiltered;
+
+  public function setIcon($icon) {
+    $this->icon = $icon;
+    return $this;
+  }
+
+  public function getIcon() {
+    if ($this->icon) {
+      return $this->icon;
+    }
+    return $this->getTypeIcon();
+  }
 
   public function getTypeIcon() {
     if ($this->getPHIDType()) {

src/applications/project/application/PhabricatorApplicationProject.php

···
           => 'PhabricatorProjectProfileController',
         'picture/(?P<id>[1-9]\d*)/' =>
           'PhabricatorProjectEditPictureController',
+        'icon/(?P<id>[1-9]\d*)/' =>
+          'PhabricatorProjectEditIconController',
         'create/' => 'PhabricatorProjectCreateController',
         'board/(?P<id>[1-9]\d*)/'.
           '(?P<filter>filter/)?'.

src/applications/project/controller/PhabricatorProjectEditIconController.php

···
+<?php
+
+final class PhabricatorProjectEditIconController
+  extends PhabricatorProjectController {
+
+  private $id;
+
+  public function willProcessRequest(array $data) {
+    $this->id = $data['id'];
+  }
+
+  public function processRequest() {
+    $request = $this->getRequest();
+    $viewer = $request->getUser();
+
+    $project = id(new PhabricatorProjectQuery())
+      ->setViewer($viewer)
+      ->withIDs(array($this->id))
+      ->requireCapabilities(
+        array(
+          PhabricatorPolicyCapability::CAN_VIEW,
+          PhabricatorPolicyCapability::CAN_EDIT,
+        ))
+      ->executeOne();
+    if (!$project) {
+      return new Aphront404Response();
+    }
+
+    $view_uri = '/tag/'.$project->getPrimarySlug().'/';
+    $edit_uri = $this->getApplicationURI('edit/'.$project->getID().'/');
+
+    if ($request->isFormPost()) {
+      $v_icon = $request->getStr('icon');
+      $type_icon = PhabricatorProjectTransaction::TYPE_ICON;
+      $xactions = array(id(new PhabricatorProjectTransaction())
+        ->setTransactionType($type_icon)
+        ->setNewValue($v_icon));
+
+      $editor = id(new PhabricatorProjectTransactionEditor())
+        ->setActor($viewer)
+        ->setContentSourceFromRequest($request)
+        ->setContinueOnMissingFields(true)
+        ->setContinueOnNoEffect(true);
+
+      $editor->applyTransactions($project, $xactions);
+
+      return id(new AphrontReloadResponse())->setURI($edit_uri);
+    }
+
+    require_celerity_resource('project-icon-css');
+    Javelin::initBehavior('phabricator-tooltips');
+
+    $project_icons = PhabricatorProjectIcon::getIconMap();
+    $ii = 0;
+    $buttons = array();
+    foreach ($project_icons as $icon => $label) {
+      $view = id(new PHUIIconView())
+        ->setIconFont($icon.' bluegrey');
+
+      $aural = javelin_tag(
+        'span',
+        array(
+          'aural' => true,
+        ),
+        pht('Choose "%s" Icon', $label));
+
+      if ($icon == $project->getIcon()) {
+        $class_extra = ' selected';
+        $tip = $label . pht(' - selected');
+      } else {
+        $class_extra = null;
+        $tip = $label;
+      }
+
+      $buttons[] = javelin_tag(
+        'button',
+        array(
+          'class' => 'icon-button'.$class_extra,
+          'name' => 'icon',
+          'value' => $icon,
+          'type' => 'submit',
+          'sigil' => 'has-tooltip',
+          'meta' => array(
+            'tip' => $tip,
+          )
+        ),
+        array(
+          $aural,
+          $view,
+        ));
+      if ((++$ii % 4) == 0) {
+        $buttons[] = phutil_tag('br');
+      }
+    }
+
+    $buttons = phutil_tag(
+      'div',
+      array(
+        'class' => 'icon-grid',
+      ),
+      $buttons);
+
+    $dialog = id(new AphrontDialogView())
+      ->setUser($viewer)
+      ->setTitle(pht('Choose Project Icon'))
+      ->appendChild($buttons)
+      ->addCancelButton($edit_uri);
+
+    return id(new AphrontDialogResponse())->setDialog($dialog);
+  }
+}

src/applications/project/controller/PhabricatorProjectEditMainController.php

···
 
     $view->addAction(
       id(new PhabricatorActionView())
+        ->setName(pht('Edit Icon'))
+        ->setIcon($project->getIcon())
+        ->setHref($this->getApplicationURI("icon/{$id}/"))
+        ->setDisabled(!$can_edit)
+        ->setWorkflow(true));
+
+    $view->addAction(
+      id(new PhabricatorActionView())
         ->setName(pht('Edit Picture'))
         ->setIcon('fa-picture-o')
         ->setHref($this->getApplicationURI("picture/{$id}/"))

src/applications/project/editor/PhabricatorProjectTransactionEditor.php

···
     $types[] = PhabricatorProjectTransaction::TYPE_SLUGS;
     $types[] = PhabricatorProjectTransaction::TYPE_STATUS;
     $types[] = PhabricatorProjectTransaction::TYPE_IMAGE;
+    $types[] = PhabricatorProjectTransaction::TYPE_ICON;
 
     return $types;
   }
···
         return $object->getStatus();
       case PhabricatorProjectTransaction::TYPE_IMAGE:
         return $object->getProfileImagePHID();
+      case PhabricatorProjectTransaction::TYPE_ICON:
+        return $object->getIcon();
     }
 
     return parent::getCustomTransactionOldValue($object, $xaction);
···
       case PhabricatorProjectTransaction::TYPE_SLUGS:
       case PhabricatorProjectTransaction::TYPE_STATUS:
       case PhabricatorProjectTransaction::TYPE_IMAGE:
+      case PhabricatorProjectTransaction::TYPE_ICON:
         return $xaction->getNewValue();
     }
 
···
         return;
       case PhabricatorProjectTransaction::TYPE_IMAGE:
         $object->setProfileImagePHID($xaction->getNewValue());
+        return;
+      case PhabricatorProjectTransaction::TYPE_ICON:
+        $object->setIcon($xaction->getNewValue());
         return;
       case PhabricatorTransactions::TYPE_EDGE:
         return;
···
       case PhabricatorTransactions::TYPE_JOIN_POLICY:
       case PhabricatorProjectTransaction::TYPE_STATUS:
       case PhabricatorProjectTransaction::TYPE_IMAGE:
+      case PhabricatorProjectTransaction::TYPE_ICON:
         return;
       case PhabricatorTransactions::TYPE_EDGE:
         $edge_type = $xaction->getMetadataValue('edge:type');
···
       case PhabricatorProjectTransaction::TYPE_NAME:
       case PhabricatorProjectTransaction::TYPE_STATUS:
       case PhabricatorProjectTransaction::TYPE_IMAGE:
+      case PhabricatorProjectTransaction::TYPE_ICON:
         PhabricatorPolicyFilter::requireCapability(
           $this->requireActor(),
           $object,

src/applications/project/editor/__tests__/PhabricatorProjectEditorTestCase.php

···
     $user2 = $this->createUser();
     $user2->save();
 
-    $proj = $this->createProject();
-    $proj->setAuthorPHID($user->getPHID());
-    $proj->save();
+    $proj = $this->createProject($user);
 
     $proj = $this->refreshProject($proj, $user, true);
 
···
     $user2 = $this->createUser();
     $user2->save();
 
-    $proj = $this->createProject();
-    $proj->setAuthorPHID($user->getPHID());
-    $proj->save();
+    $proj = $this->createProject($user);
 
 
     // When edit and view policies are set to "user", anyone can edit.
···
     $user->save();
 
     $proj = $this->createProjectWithNewAuthor();
-    $proj->save();
 
     $proj = $this->refreshProject($proj, $user, true);
     $this->assertTrue(
···
     }
   }
 
-  private function createProject() {
-    $project = new PhabricatorProject();
+  private function createProject(PhabricatorUser $user) {
+    $project = PhabricatorProject::initializeNewProject($user);
     $project->setName('Test Project '.mt_rand());
+    $project->save();
 
     return $project;
   }
···
     $author = $this->createUser();
     $author->save();
 
-    $project = $this->createProject();
-    $project->setAuthorPHID($author->getPHID());
+    $project = $this->createProject($author);
 
     return $project;
   }

src/applications/project/icon/PhabricatorProjectIcon.php

···
+<?php
+
+final class PhabricatorProjectIcon extends Phobject {
+
+  public static function getIconMap() {
+    return
+      array(
+        'fa-briefcase' => pht('Briefcase'),
+        'fa-tags' => pht('Tag'),
+        'fa-folder' => pht('Folder'),
+        'fa-users' => pht('Team'),
+        'fa-bug' => pht('Bug'),
+        'fa-trash-o' => pht('Garbage'),
+        'fa-calendar' => pht('Deadline'),
+        'fa-flag-checkered' => pht('Goal'),
+        'fa-envelope' => pht('Communication'),
+        'fa-truck' => pht('Release'),
+        'fa-lock' => pht('Policy'),
+        'fa-umbrella' => pht('An Umbrella'),
+      );
+  }
+
+  public static function getLabel($key) {
+    $map = self::getIconMap();
+    return $map[$key];
+  }
+}

src/applications/project/phid/PhabricatorProjectPHIDTypeProject.php

···
       $handle->setObjectName('#'.$slug);
       $handle->setURI("/tag/{$slug}/");
       $handle->setImageURI($project->getProfileImageURI());
+      $handle->setIcon($project->getIcon());
 
       if ($project->isArchived()) {
         $handle->setStatus(PhabricatorObjectHandleStatus::STATUS_CLOSED);

src/applications/project/storage/PhabricatorProject.php

···
   protected $subprojectPHIDs = array();
   protected $phrictionSlug;
   protected $profileImagePHID;
+  protected $icon;
 
   protected $viewPolicy;
   protected $editPolicy;
···
   private $profileImageFile = self::ATTACHABLE;
   private $slugs = self::ATTACHABLE;
 
+  const DEFAULT_ICON = 'fa-briefcase';
+
   public static function initializeNewProject(PhabricatorUser $actor) {
     return id(new PhabricatorProject())
       ->setName('')
       ->setAuthorPHID($actor->getPHID())
+      ->setIcon(self::DEFAULT_ICON)
       ->setViewPolicy(PhabricatorPolicies::POLICY_USER)
       ->setEditPolicy(PhabricatorPolicies::POLICY_USER)
       ->setJoinPolicy(PhabricatorPolicies::POLICY_USER)

src/applications/project/storage/PhabricatorProjectTransaction.php

···
   const TYPE_SLUGS      = 'project:slugs';
   const TYPE_STATUS     = 'project:status';
   const TYPE_IMAGE      = 'project:image';
+  const TYPE_ICON       = 'project:icon';
 
   // NOTE: This is deprecated, members are just a normal edge now.
   const TYPE_MEMBERS    = 'project:members';
···
             $this->renderHandleLink($old),
             $this->renderHandleLink($new));
         }
+
+      case PhabricatorProjectTransaction::TYPE_ICON:
+        return pht(
+          '%s set this project\'s icon to %s.',
+          $author_handle,
+          PhabricatorProjectIcon::getLabel($new));
 
       case PhabricatorProjectTransaction::TYPE_SLUGS:
         $add = array_diff($new, $old);

src/applications/typeahead/controller/PhabricatorTypeaheadCommonDatasourceController.php

···
           ->setDisplayType("Project")
           ->setURI('/project/view/'.$proj->getID().'/')
           ->setPHID($proj->getPHID())
-          ->setIcon('fa-briefcase bluegrey')
+          ->setIcon($proj->getIcon().' bluegrey')
           ->setClosed($closed);
 
         $proj_result->setImageURI($proj->getProfileImageURI());

src/view/form/control/AphrontFormTokenizerControl.php

···
         'id'          => $id,
         'src'         => $this->datasource,
         'value'       => mpull($values, 'getFullName', 'getPHID'),
-        'icons'       => mpull($values, 'getTypeIcon', 'getPHID'),
+        'icons'       => mpull($values, 'getIcon', 'getPHID'),
         'limit'       => $this->limit,
         'username'    => $username,
         'placeholder' => $this->placeholder,

webroot/rsrc/css/application/projects/project-icon.css

···
+/**
+ * @provides project-icon-css
+ */
+
+button.icon-button {
+  background: #f7f7f7;
+  border: 1px solid {$lightblueborder};
+  position: relative;
+  width: 16px;
+  height: 16px;
+  padding: 12px;
+  margin: 4px;
+  text-shadow: none;
+  box-shadow: none;
+  box-sizing: content-box;
+}
+
+.icon-grid {
+  text-align: center;
+}
+
+.icon-icon + .icon-icon {
+  margin-left: 4px;
+}
+
+button.icon-button.selected {
+  background: {$bluebackground};
+}