PHUITimelineEventView.php

<?php

final class PHUITimelineEventView extends AphrontView {

  const DELIMITER = " \xC2\xB7 ";

  private $userHandle;
  private $title;
  private $icon;
  private $color;
  private $classes = array();
  private $contentSource;
  private $dateCreated;
  private $anchor;
  private $isEditable;
  private $isEdited;
  private $isRemovable;
  private $transactionPHID;
  private $isPreview;
  private $eventGroup = array();
  private $hideByDefault;
  private $token;
  private $tokenRemoved;
  private $quoteTargetID;
  private $isNormalComment;
  private $quoteRef;
  private $reallyMajorEvent;
  private $hideCommentOptions = false;
  private $authorPHID;
  private $badges = array();
  private $pinboardItems = array();
  private $isSilent;
  private $isMFA;
  private $isLockOverride;
  private $canInteract;

  public function setAuthorPHID($author_phid) {
    $this->authorPHID = $author_phid;
    return $this;
  }

  public function getAuthorPHID() {
    return $this->authorPHID;
  }

  public function setQuoteRef($quote_ref) {
    $this->quoteRef = $quote_ref;
    return $this;
  }

  public function getQuoteRef() {
    return $this->quoteRef;
  }

  public function setQuoteTargetID($quote_target_id) {
    $this->quoteTargetID = $quote_target_id;
    return $this;
  }

  public function getQuoteTargetID() {
    return $this->quoteTargetID;
  }

  public function setIsNormalComment($is_normal_comment) {
    $this->isNormalComment = $is_normal_comment;
    return $this;
  }

  public function getIsNormalComment() {
    return $this->isNormalComment;
  }

  public function setHideByDefault($hide_by_default) {
    $this->hideByDefault = $hide_by_default;
    return $this;
  }

  public function getHideByDefault() {
    return $this->hideByDefault;
  }

  public function setTransactionPHID($transaction_phid) {
    $this->transactionPHID = $transaction_phid;
    return $this;
  }

  public function getTransactionPHID() {
    return $this->transactionPHID;
  }

  public function setIsEdited($is_edited) {
    $this->isEdited = $is_edited;
    return $this;
  }

  public function getIsEdited() {
    return $this->isEdited;
  }

  public function setIsPreview($is_preview) {
    $this->isPreview = $is_preview;
    return $this;
  }

  public function getIsPreview() {
    return $this->isPreview;
  }

  public function setIsEditable($is_editable) {
    $this->isEditable = $is_editable;
    return $this;
  }

  public function getIsEditable() {
    return $this->isEditable;
  }

  public function setCanInteract($can_interact) {
    $this->canInteract = $can_interact;
    return $this;
  }

  public function getCanInteract() {
    return $this->canInteract;
  }

  public function setIsRemovable($is_removable) {
    $this->isRemovable = $is_removable;
    return $this;
  }

  public function getIsRemovable() {
    return $this->isRemovable;
  }

  public function setDateCreated($date_created) {
    $this->dateCreated = $date_created;
    return $this;
  }

  public function getDateCreated() {
    return $this->dateCreated;
  }

  public function setContentSource(PhabricatorContentSource $content_source) {
    $this->contentSource = $content_source;
    return $this;
  }

  public function getContentSource() {
    return $this->contentSource;
  }

  public function setUserHandle(PhabricatorObjectHandle $handle) {
    $this->userHandle = $handle;
    return $this;
  }

  public function setAnchor($anchor) {
    $this->anchor = $anchor;
    return $this;
  }

  public function getAnchor() {
    return $this->anchor;
  }

  public function setTitle($title) {
    $this->title = $title;
    return $this;
  }

  public function addClass($class) {
    $this->classes[] = $class;
    return $this;
  }

  public function addBadge(PHUIBadgeMiniView $badge) {
    $this->badges[] = $badge;
    return $this;
  }

  public function setIcon($icon) {
    $this->icon = $icon;
    return $this;
  }

  public function setColor($color) {
    $this->color = $color;
    return $this;
  }

  public function setIsSilent($is_silent) {
    $this->isSilent = $is_silent;
    return $this;
  }

  public function getIsSilent() {
    return $this->isSilent;
  }

  public function setIsMFA($is_mfa) {
    $this->isMFA = $is_mfa;
    return $this;
  }

  public function getIsMFA() {
    return $this->isMFA;
  }

  public function setIsLockOverride($is_override) {
    $this->isLockOverride = $is_override;
    return $this;
  }

  public function getIsLockOverride() {
    return $this->isLockOverride;
  }

  public function setReallyMajorEvent($me) {
    $this->reallyMajorEvent = $me;
    return $this;
  }

  public function setHideCommentOptions($hide_comment_options) {
    $this->hideCommentOptions = $hide_comment_options;
    return $this;
  }

  public function getHideCommentOptions() {
    return $this->hideCommentOptions;
  }

  public function addPinboardItem(PHUIPinboardItemView $item) {
    $this->pinboardItems[] = $item;
    return $this;
  }

  public function setToken($token, $removed = false) {
    $this->token = $token;
    $this->tokenRemoved = $removed;
    return $this;
  }

  public function getEventGroup() {
    return array_merge(array($this), $this->eventGroup);
  }

  public function addEventToGroup(PHUITimelineEventView $event) {
    $this->eventGroup[] = $event;
    return $this;
  }

  protected function shouldRenderEventTitle() {
    if ($this->title === null) {
      return false;
    }

    return true;
  }

  protected function renderEventTitle($force_icon, $has_menu, $extra) {
    $title = $this->title;

    $title_classes = array();
    $title_classes[] = 'phui-timeline-title';

    $icon = null;
    if ($this->icon || $force_icon) {
      $title_classes[] = 'phui-timeline-title-with-icon';
    }

    if ($has_menu) {
      $title_classes[] = 'phui-timeline-title-with-menu';
    }

    if ($this->icon) {
      $fill_classes = array();
      $fill_classes[] = 'phui-timeline-icon-fill';
      if ($this->color) {
        $fill_classes[] = 'fill-has-color';
        $fill_classes[] = 'phui-timeline-icon-fill-'.$this->color;
      }

      $icon = id(new PHUIIconView())
        ->setIcon($this->icon)
        ->addClass('phui-timeline-icon');

      $icon = phutil_tag(
        'span',
        array(
          'class' => implode(' ', $fill_classes),
        ),
        $icon);
    }

    $token = null;
    if ($this->token) {
      $token = id(new PHUIIconView())
        ->addClass('phui-timeline-token')
        ->setSpriteSheet(PHUIIconView::SPRITE_TOKENS)
        ->setSpriteIcon($this->token);
      if ($this->tokenRemoved) {
        $token->addClass('strikethrough');
      }
    }

    $title = phutil_tag(
      'div',
      array(
        'class' => implode(' ', $title_classes),
      ),
      array($icon, $token, $title, $extra));

    return $title;
  }

  public function render() {

    $events = $this->getEventGroup();

    // Move events with icons first.
    $icon_keys = array();
    foreach ($this->getEventGroup() as $key => $event) {
      if ($event->icon) {
        $icon_keys[] = $key;
      }
    }
    $events = array_select_keys($events, $icon_keys) + $events;
    $force_icon = (bool)$icon_keys;

    $menu = null;
    $items = array();
    if (!$this->getIsPreview() && !$this->getHideCommentOptions()) {
      foreach ($this->getEventGroup() as $event) {
        $items[] = $event->getMenuItems($this->anchor);
      }
      $items = array_mergev($items);
    }

    if ($items) {
      $icon = id(new PHUIIconView())
        ->setIcon('fa-caret-down');
      $aural = javelin_tag(
        'span',
        array(
          'aural' => true,
        ),
        pht('Comment Actions'));

      if ($items) {
        $sigil = 'phui-dropdown-menu';
        Javelin::initBehavior('phui-dropdown-menu');
      } else {
        $sigil = null;
      }

      $action_list = id(new PhabricatorActionListView())
        ->setUser($this->getUser());
      foreach ($items as $item) {
        $action_list->addAction($item);
      }

      $menu = javelin_tag(
        $items ? 'a' : 'span',
        array(
          'href' => '#',
          'class' => 'phui-timeline-menu',
          'sigil' => $sigil,
          'aria-haspopup' => 'true',
          'aria-expanded' => 'false',
          'meta' => $action_list->getDropdownMenuMetadata(),
        ),
        array(
          $aural,
          $icon,
        ));

      $has_menu = true;
    } else {
      $has_menu = false;
    }

    // Render "extra" information (timestamp, etc).
    $extra = $this->renderExtra($events);

    $show_badges = false;

    $group_titles = array();
    $group_items = array();
    $group_children = array();
    foreach ($events as $event) {
      if ($event->shouldRenderEventTitle()) {

        // Render the group anchor here, outside the title box. If we render
        // it inside the title box it ends up completely hidden and Chrome 55
        // refuses to jump to it. See T11997 for discussion.

        if ($extra && $this->anchor) {
          $group_titles[] = id(new PhabricatorAnchorView())
            ->setAnchorName($this->anchor)
            ->render();
        }

        $group_titles[] = $event->renderEventTitle(
          $force_icon,
          $has_menu,
          $extra);

        // Don't render this information more than once.
        $extra = null;
      }

      if ($event->hasChildren()) {
        $group_children[] = $event->renderChildren();
        $show_badges = true;
      }
    }

    $image_uri = $this->userHandle->getImageURI();

    $wedge = phutil_tag(
      'div',
      array(
        'class' => 'phui-timeline-wedge',
        'style' => (nonempty($image_uri)) ? '' : 'display: none;',
      ),
      '');

    $image = null;
    $badges = null;
    if ($image_uri) {
      $image = javelin_tag(
        ($this->userHandle->getURI()) ? 'a' : 'div',
        array(
          'style' => 'background-image: url('.$image_uri.')',
          'class' => 'phui-timeline-image',
          'href' => $this->userHandle->getURI(),
          'aural' => false,
        ),
        '');
      if ($this->badges && $show_badges) {
        $flex = new PHUIBadgeBoxView();
        $flex->addItems($this->badges);
        $flex->setCollapsed(true);
        $badges = phutil_tag(
          'div',
          array(
            'class' => 'phui-timeline-badges',
          ),
          $flex);
      }
    }

    $content_classes = array();
    $content_classes[] = 'phui-timeline-content';

    $classes = array();
    $classes[] = 'phui-timeline-event-view';
    if ($group_children) {
      $classes[] = 'phui-timeline-major-event';
      $content = phutil_tag(
        'div',
        array(
          'class' => 'phui-timeline-inner-content',
        ),
        array(
          $group_titles,
          $menu,
          phutil_tag(
            'div',
            array(
              'class' => 'phui-timeline-core-content',
            ),
            $group_children),
        ));
    } else {
      $classes[] = 'phui-timeline-minor-event';
      $content = $group_titles;
    }

    $content = phutil_tag(
      'div',
      array(
        'class' => 'phui-timeline-group',
      ),
      $content);

    // Image Events
    $pinboard = null;
    if ($this->pinboardItems) {
      $pinboard = new PHUIPinboardView();
      foreach ($this->pinboardItems as $item) {
        $pinboard->addItem($item);
      }
    }

    $content = phutil_tag(
      'div',
      array(
        'class' => implode(' ', $content_classes),
      ),
      array($image, $badges, $wedge, $content, $pinboard));

    $outer_classes = $this->classes;
    $outer_classes[] = 'phui-timeline-shell';
    $color = null;
    foreach ($this->getEventGroup() as $event) {
      if ($event->color) {
        $color = $event->color;
        break;
      }
    }

    if ($color) {
      $outer_classes[] = 'phui-timeline-'.$color;
    }

    $sigils = array();
    $meta = null;
    if ($this->getTransactionPHID()) {
      $sigils[] = 'transaction';
      $meta = array(
        'phid' => $this->getTransactionPHID(),
        'anchor' => $this->anchor,
      );
    }

    $major_event = null;
    if ($this->reallyMajorEvent) {
      $major_event = phutil_tag(
        'div',
        array(
          'class' => 'phui-timeline-event-view '.
                     'phui-timeline-spacer '.
                     'phui-timeline-spacer-bold',
        ));
    }

    $sigils[] = 'anchor-container';

    return array(
      javelin_tag(
        'div',
        array(
          'class' => implode(' ', $outer_classes),
          'sigil' => implode(' ', $sigils),
          'meta' => $meta,
        ),
        phutil_tag(
          'div',
          array(
            'class' => implode(' ', $classes),
          ),
          $content)),
      $major_event,
    );
  }

  private function renderExtra(array $events) {
    $extra = array();

    if ($this->getIsPreview()) {
      $extra[] = pht('PREVIEW');
    } else {
      foreach ($events as $event) {
        if ($event->getIsEdited()) {
          $extra[] = pht('Edited');
          break;
        }
      }

      $source = $this->getContentSource();
      $content_source = null;
      if ($source) {
        $content_source = id(new PhabricatorContentSourceView())
          ->setContentSource($source)
          ->setUser($this->getUser());
        $content_source = pht('Via %s', $content_source->getSourceName());
      }

      $date_created = null;
      foreach ($events as $event) {
        if ($event->getDateCreated()) {
          if ($date_created === null) {
            $date_created = $event->getDateCreated();
          } else {
            $date_created = min($event->getDateCreated(), $date_created);
          }
        }
      }

      if ($date_created) {
        $date = phabricator_dual_datetime(
          $date_created,
          $this->getUser());
        if ($this->anchor) {
          Javelin::initBehavior('phabricator-watch-anchor');
          Javelin::initBehavior('phabricator-tooltips');

          $date = array(
            javelin_tag(
              'a',
              array(
                'href' => '#'.$this->anchor,
                'sigil' => 'has-tooltip',
                'meta' => array(
                  'tip' => $content_source,
                ),
              ),
              $date),
          );
        }

        $extra[] = $date;
      }

      // If this edit was applied silently, give user a hint that they should
      // not expect to have received any mail or notifications.
      if ($this->getIsSilent()) {
        $extra[] = id(new PHUIIconView())
          ->setIcon('fa-bell-slash', 'white')
          ->setEmblemColor('red')
          ->setTooltip(pht('Silent Edit'));
      }

      // If this edit was applied while the actor was in high-security mode,
      // provide a hint that it was extra authentic.
      if ($this->getIsMFA()) {
        $extra[] = id(new PHUIIconView())
          ->setIcon('fa-vcard', 'white')
          ->setEmblemColor('pink')
          ->setTooltip(pht('MFA Authenticated'));
      }

      if ($this->getIsLockOverride()) {
        $extra[] = id(new PHUIIconView())
          ->setIcon('fa-chain-broken', 'white')
          ->setEmblemColor('violet')
          ->setTooltip(pht('Lock Overridden'));
      }
    }

    $extra = javelin_tag(
      'span',
      array(
        'class' => 'phui-timeline-extra',
      ),
      phutil_implode_html(
        javelin_tag(
          'span',
          array(
            'aural' => false,
          ),
          self::DELIMITER),
        $extra));

    return $extra;
  }

  private function getMenuItems($anchor) {
    $xaction_phid = $this->getTransactionPHID();

    $can_interact = $this->getCanInteract();
    $viewer = $this->getViewer();
    $is_admin = $viewer->getIsAdmin();

    $items = array();

    if ($this->getIsEditable()) {
      $items[] = id(new PhabricatorActionView())
        ->setIcon('fa-pencil')
        ->setHref('/transactions/edit/'.$xaction_phid.'/')
        ->setName(pht('Edit Comment'))
        ->addSigil('transaction-edit')
        ->setDisabled(!$can_interact)
        ->setMetadata(
          array(
            'anchor' => $anchor,
          ));
    }

    if ($this->getQuoteTargetID()) {
      $ref = null;
      if ($this->getQuoteRef()) {
        $ref = $this->getQuoteRef();
        if ($anchor) {
          $ref = $ref.'#'.$anchor;
        }
      }

      $items[] = id(new PhabricatorActionView())
        ->setIcon('fa-quote-left')
        ->setName(pht('Quote Comment'))
        ->setHref('#')
        ->addSigil('transaction-quote')
        ->setMetadata(
          array(
            'targetID' => $this->getQuoteTargetID(),
            'uri' => '/transactions/quote/'.$xaction_phid.'/',
            'ref' => $ref,
          ));
    }

    if ($this->getIsNormalComment()) {
      $items[] = id(new PhabricatorActionView())
        ->setIcon('fa-code')
        ->setHref('/transactions/raw/'.$xaction_phid.'/')
        ->setName(pht('View Raw Remarkup'))
        ->addSigil('transaction-raw')
        ->setMetadata(
          array(
            'anchor' => $anchor,
          ));

      $content_source = $this->getContentSource();
      $source_email = PhabricatorEmailContentSource::SOURCECONST;
      if ($content_source->getSource() == $source_email) {
        $source_id = $content_source->getContentSourceParameter('id');
        if ($source_id) {
          $items[] = id(new PhabricatorActionView())
            ->setIcon('fa-envelope-o')
            ->setHref('/transactions/raw/'.$xaction_phid.'/?email')
            ->setName(pht('View Email Body'))
            ->addSigil('transaction-raw')
            ->setMetadata(
              array(
                'anchor' => $anchor,
              ));
        }
      }
    }

    if ($this->getIsEdited()) {
      $items[] = id(new PhabricatorActionView())
        ->setIcon('fa-list')
        ->setHref('/transactions/history/'.$xaction_phid.'/')
        ->setName(pht('View Edit History'))
        ->setWorkflow(true);
    }

    if ($this->getIsRemovable()) {
      $items[] = id(new PhabricatorActionView())
        ->setType(PhabricatorActionView::TYPE_DIVIDER);

      $remove_item = id(new PhabricatorActionView())
        ->setIcon('fa-trash-o')
        ->setHref('/transactions/remove/'.$xaction_phid.'/')
        ->setName(pht('Remove Comment'))
        ->addSigil('transaction-remove')
        ->setMetadata(
          array(
            'anchor' => $anchor,
          ));

      if (!$is_admin && !$can_interact) {
        $remove_item->setDisabled(!$is_admin && !$can_interact);
      } else {
        $remove_item->setColor(PhabricatorActionView::RED);
      }

      $items[] = $remove_item;
    }

    return $items;
  }

}