ManiphestReportController.php
No OneTemporary
Actions

Subscribers

None

File Metadata

Created: Mon, Nov 25, 10:04

ManiphestReportController.php
View Options

	<?php

	final class ManiphestReportController extends ManiphestController {

	private $view;

	public function willProcessRequest(array $data) {
	$this->view = idx($data, 'view');
	}

	public function processRequest() {
	$request = $this->getRequest();
	$user = $request->getUser();

	if ($request->isFormPost()) {
	$uri = $request->getRequestURI();

	$project = head($request->getArr('set_project'));
	$project = nonempty($project, null);
	$uri = $uri->alter('project', $project);

	$window = $request->getStr('set_window');
	$uri = $uri->alter('window', $window);

	return id(new AphrontRedirectResponse())->setURI($uri);
	}

	$nav = new AphrontSideNavFilterView();
	$nav->setBaseURI(new PhutilURI('/maniphest/report/'));
	$nav->addLabel(pht('Open Tasks'));
	$nav->addFilter('user', pht('By User'));
	$nav->addFilter('project', pht('By Project'));
	$nav->addLabel(pht('Burnup'));
	$nav->addFilter('burn', pht('Burnup Rate'));

	$this->view = $nav->selectFilter($this->view, 'user');

	require_celerity_resource('maniphest-report-css');

	switch ($this->view) {
	case 'burn':
	$core = $this->renderBurn();
	break;
	case 'user':
	case 'project':
	$core = $this->renderOpenTasks();
	break;
	default:
	return new Aphront404Response();
	}

	$nav->appendChild($core);
	$nav->setCrumbs(
	$this->buildApplicationCrumbs()
	->setBorder(true)
	->addTextCrumb(pht('Reports')));

	return $this->buildApplicationPage(
	$nav,
	array(
	'title' => pht('Maniphest Reports'),
	'device' => false,
	));
	}

	public function renderBurn() {
	$request = $this->getRequest();
	$user = $request->getUser();

	$handle = null;

	$project_phid = $request->getStr('project');
	if ($project_phid) {
	$phids = array($project_phid);
	$handles = $this->loadViewerHandles($phids);
	$handle = $handles[$project_phid];
	}

	$table = new ManiphestTransaction();
	$conn = $table->establishConnection('r');

	$joins = '';
	if ($project_phid) {
	$joins = qsprintf(
	$conn,
	'JOIN %T t ON x.objectPHID = t.phid
	JOIN %T p ON p.src = t.phid AND p.type = %d AND p.dst = %s',
	id(new ManiphestTask())->getTableName(),
	PhabricatorEdgeConfig::TABLE_NAME_EDGE,
	PhabricatorProjectObjectHasProjectEdgeType::EDGECONST,
	$project_phid);
	}

	$data = queryfx_all(
	$conn,
	'SELECT x.oldValue, x.newValue, x.dateCreated FROM %T x %Q
	WHERE transactionType = %s
	ORDER BY x.dateCreated ASC',
	$table->getTableName(),
	$joins,
	ManiphestTransaction::TYPE_STATUS);

	$stats = array();
	$day_buckets = array();

	$open_tasks = array();

	foreach ($data as $key => $row) {

	// NOTE: Hack to avoid json_decode().
	$oldv = trim($row['oldValue'], '"');
	$newv = trim($row['newValue'], '"');

	if ($oldv == 'null') {
	$old_is_open = false;
	} else {
	$old_is_open = ManiphestTaskStatus::isOpenStatus($oldv);
	}

	$new_is_open = ManiphestTaskStatus::isOpenStatus($newv);

	$is_open = ($new_is_open && !$old_is_open);
	$is_close = ($old_is_open && !$new_is_open);

	$data[$key]['_is_open'] = $is_open;
	$data[$key]['_is_close'] = $is_close;

	if (!$is_open && !$is_close) {
	// This is either some kind of bogus event, or a resolution change
	// (e.g., resolved -> invalid). Just skip it.
	continue;
	}

	$day_bucket = phabricator_format_local_time(
	$row['dateCreated'],
	$user,
	'Yz');
	$day_buckets[$day_bucket] = $row['dateCreated'];
	if (empty($stats[$day_bucket])) {
	$stats[$day_bucket] = array(
	'open' => 0,
	'close' => 0,
	);
	}
	$stats[$day_bucket][$is_close ? 'close' : 'open']++;
	}

	$template = array(
	'open' => 0,
	'close' => 0,
	);

	$rows = array();
	$rowc = array();
	$last_month = null;
	$last_month_epoch = null;
	$last_week = null;
	$last_week_epoch = null;
	$week = null;
	$month = null;

	$last = last_key($stats) - 1;
	$period = $template;

	foreach ($stats as $bucket => $info) {
	$epoch = $day_buckets[$bucket];

	$week_bucket = phabricator_format_local_time(
	$epoch,
	$user,
	'YW');
	if ($week_bucket != $last_week) {
	if ($week) {
	$rows[] = $this->formatBurnRow(
	'Week of '.phabricator_date($last_week_epoch, $user),
	$week);
	$rowc[] = 'week';
	}
	$week = $template;
	$last_week = $week_bucket;
	$last_week_epoch = $epoch;
	}

	$month_bucket = phabricator_format_local_time(
	$epoch,
	$user,
	'Ym');
	if ($month_bucket != $last_month) {
	if ($month) {
	$rows[] = $this->formatBurnRow(
	phabricator_format_local_time($last_month_epoch, $user, 'F, Y'),
	$month);
	$rowc[] = 'month';
	}
	$month = $template;
	$last_month = $month_bucket;
	$last_month_epoch = $epoch;
	}

	$rows[] = $this->formatBurnRow(phabricator_date($epoch, $user), $info);
	$rowc[] = null;
	$week['open'] += $info['open'];
	$week['close'] += $info['close'];
	$month['open'] += $info['open'];
	$month['close'] += $info['close'];
	$period['open'] += $info['open'];
	$period['close'] += $info['close'];
	}

	if ($week) {
	$rows[] = $this->formatBurnRow(
	pht('Week To Date'),
	$week);
	$rowc[] = 'week';
	}

	if ($month) {
	$rows[] = $this->formatBurnRow(
	pht('Month To Date'),
	$month);
	$rowc[] = 'month';
	}

	$rows[] = $this->formatBurnRow(
	pht('All Time'),
	$period);
	$rowc[] = 'aggregate';

	$rows = array_reverse($rows);
	$rowc = array_reverse($rowc);

	$table = new AphrontTableView($rows);
	$table->setRowClasses($rowc);
	$table->setHeaders(
	array(
	pht('Period'),
	pht('Opened'),
	pht('Closed'),
	pht('Change'),
	));
	$table->setColumnClasses(
	array(
	'right wide',
	'n',
	'n',
	'n',
	));

	if ($handle) {
	$inst = pht(
	'NOTE: This table reflects tasks currently in '.
	'the project. If a task was opened in the past but added to '.
	'the project recently, it is counted on the day it was '.
	'opened, not the day it was categorized. If a task was part '.
	'of this project in the past but no longer is, it is not '.
	'counted at all.');
	$header = pht('Task Burn Rate for Project %s', $handle->renderLink());
	$caption = phutil_tag('p', array(), $inst);
	} else {
	$header = pht('Task Burn Rate for All Tasks');
	$caption = null;
	}

	if ($caption) {
	$caption = id(new PHUIInfoView())
	->appendChild($caption)
	->setSeverity(PHUIInfoView::SEVERITY_NOTICE);
	}

	$panel = new PHUIObjectBoxView();
	$panel->setHeaderText($header);
	if ($caption) {
	$panel->setErrorView($caption);
	}
	$panel->appendChild($table);

	$tokens = array();
	if ($handle) {
	$tokens = array($handle);
	}

	$filter = $this->renderReportFilters($tokens, $has_window = false);

	$id = celerity_generate_unique_node_id();
	$chart = phutil_tag(
	'div',
	array(
	'id' => $id,
	'style' => 'border: 1px solid #BFCFDA; '.
	'background-color: #fff; '.
	'margin: 8px 16px; '.
	'height: 400px; ',
	),
	'');

	list($burn_x, $burn_y) = $this->buildSeries($data);

	require_celerity_resource('raphael-core');
	require_celerity_resource('raphael-g');
	require_celerity_resource('raphael-g-line');

	Javelin::initBehavior('line-chart', array(
	'hardpoint' => $id,
	'x' => array(
	$burn_x,
	),
	'y' => array(
	$burn_y,
	),
	'xformat' => 'epoch',
	'yformat' => 'int',
	));

	return array($filter, $chart, $panel);
	}

	private function renderReportFilters(array $tokens, $has_window) {
	$request = $this->getRequest();
	$user = $request->getUser();

	$form = id(new AphrontFormView())
	->setUser($user)
	->appendChild(
	id(new AphrontFormTokenizerControl())
	->setDatasource(new PhabricatorProjectDatasource())
	->setLabel(pht('Project'))
	->setLimit(1)
	->setName('set_project')
	->setValue($tokens));

	if ($has_window) {
	list($window_str, $ignored, $window_error) = $this->getWindow();
	$form
	->appendChild(
	id(new AphrontFormTextControl())
	->setLabel(pht('Recently Means'))
	->setName('set_window')
	->setCaption(
	pht('Configure the cutoff for the "Recently Closed" column.'))
	->setValue($window_str)
	->setError($window_error));
	}

	$form
	->appendChild(
	id(new AphrontFormSubmitControl())
	->setValue(pht('Filter By Project')));

	$filter = new AphrontListFilterView();
	$filter->appendChild($form);

	return $filter;
	}

	private function buildSeries(array $data) {
	$out = array();

	$counter = 0;
	foreach ($data as $row) {
	$t = (int)$row['dateCreated'];
	if ($row['_is_close']) {
	--$counter;
	$out[$t] = $counter;
	} else if ($row['_is_open']) {
	++$counter;
	$out[$t] = $counter;
	}
	}

	return array(array_keys($out), array_values($out));
	}

	private function formatBurnRow($label, $info) {
	$delta = $info['open'] - $info['close'];
	$fmt = number_format($delta);
	if ($delta > 0) {
	$fmt = '+'.$fmt;
	$fmt = phutil_tag('span', array('class' => 'red'), $fmt);
	} else {
	$fmt = phutil_tag('span', array('class' => 'green'), $fmt);
	}

	return array(
	$label,
	number_format($info['open']),
	number_format($info['close']),
	$fmt,
	);
	}

	public function renderOpenTasks() {
	$request = $this->getRequest();
	$user = $request->getUser();


	$query = id(new ManiphestTaskQuery())
	->setViewer($user)
	->withStatuses(ManiphestTaskStatus::getOpenStatusConstants());

	switch ($this->view) {
	case 'project':
	$query->needProjectPHIDs(true);
	break;
	}

	$project_phid = $request->getStr('project');
	$project_handle = null;
	if ($project_phid) {
	$phids = array($project_phid);
	$handles = $this->loadViewerHandles($phids);
	$project_handle = $handles[$project_phid];

	$query->withAnyProjects($phids);
	}

	$tasks = $query->execute();

	$recently_closed = $this->loadRecentlyClosedTasks();

	$date = phabricator_date(time(), $user);

	switch ($this->view) {
	case 'user':
	$result = mgroup($tasks, 'getOwnerPHID');
	$leftover = idx($result, '', array());
	unset($result['']);

	$result_closed = mgroup($recently_closed, 'getOwnerPHID');
	$leftover_closed = idx($result_closed, '', array());
	unset($result_closed['']);

	$base_link = '/maniphest/?assigned=';
	$leftover_name = phutil_tag('em', array(), pht('(Up For Grabs)'));
	$col_header = pht('User');
	$header = pht('Open Tasks by User and Priority (%s)', $date);
	break;
	case 'project':
	$result = array();
	$leftover = array();
	foreach ($tasks as $task) {
	$phids = $task->getProjectPHIDs();
	if ($phids) {
	foreach ($phids as $project_phid) {
	$result[$project_phid][] = $task;
	}
	} else {
	$leftover[] = $task;
	}
	}

	$result_closed = array();
	$leftover_closed = array();
	foreach ($recently_closed as $task) {
	$phids = $task->getProjectPHIDs();
	if ($phids) {
	foreach ($phids as $project_phid) {
	$result_closed[$project_phid][] = $task;
	}
	} else {
	$leftover_closed[] = $task;
	}
	}

	$base_link = '/maniphest/?allProjects=';
	$leftover_name = phutil_tag('em', array(), pht('(No Project)'));
	$col_header = pht('Project');
	$header = pht('Open Tasks by Project and Priority (%s)', $date);
	break;
	}

	$phids = array_keys($result);
	$handles = $this->loadViewerHandles($phids);
	$handles = msort($handles, 'getName');

	$order = $request->getStr('order', 'name');
	list($order, $reverse) = AphrontTableView::parseSort($order);

	require_celerity_resource('aphront-tooltip-css');
	Javelin::initBehavior('phabricator-tooltips', array());

	$rows = array();
	$pri_total = array();
	foreach (array_merge($handles, array(null)) as $handle) {
	if ($handle) {
	if (($project_handle) &&
	($project_handle->getPHID() == $handle->getPHID())) {
	// If filtering by, e.g., "bugs", don't show a "bugs" group.
	continue;
	}

	$tasks = idx($result, $handle->getPHID(), array());
	$name = phutil_tag(
	'a',
	array(
	'href' => $base_link.$handle->getPHID(),
	),
	$handle->getName());
	$closed = idx($result_closed, $handle->getPHID(), array());
	} else {
	$tasks = $leftover;
	$name = $leftover_name;
	$closed = $leftover_closed;
	}

	$taskv = $tasks;
	$tasks = mgroup($tasks, 'getPriority');

	$row = array();
	$row[] = $name;
	$total = 0;
	foreach (ManiphestTaskPriority::getTaskPriorityMap() as $pri => $label) {
	$n = count(idx($tasks, $pri, array()));
	if ($n == 0) {
	$row[] = '-';
	} else {
	$row[] = number_format($n);
	}
	$total += $n;
	}
	$row[] = number_format($total);

	list($link, $oldest_all) = $this->renderOldest($taskv);
	$row[] = $link;

	$normal_or_better = array();
	foreach ($taskv as $id => $task) {
	// TODO: This is sort of a hard-code for the default "normal" status.
	// When reports are more powerful, this should be made more general.
	if ($task->getPriority() < 50) {
	continue;
	}
	$normal_or_better[$id] = $task;
	}

	list($link, $oldest_pri) = $this->renderOldest($normal_or_better);
	$row[] = $link;

	if ($closed) {
	$task_ids = implode(',', mpull($closed, 'getID'));
	$row[] = phutil_tag(
	'a',
	array(
	'href' => '/maniphest/?ids='.$task_ids,
	'target' => '_blank',
	),
	number_format(count($closed)));
	} else {
	$row[] = '-';
	}

	switch ($order) {
	case 'total':
	$row['sort'] = $total;
	break;
	case 'oldest-all':
	$row['sort'] = $oldest_all;
	break;
	case 'oldest-pri':
	$row['sort'] = $oldest_pri;
	break;
	case 'closed':
	$row['sort'] = count($closed);
	break;
	case 'name':
	default:
	$row['sort'] = $handle ? $handle->getName() : '~';
	break;
	}

	$rows[] = $row;
	}

	$rows = isort($rows, 'sort');
	foreach ($rows as $k => $row) {
	unset($rows[$k]['sort']);
	}
	if ($reverse) {
	$rows = array_reverse($rows);
	}

	$cname = array($col_header);
	$cclass = array('pri right wide');
	$pri_map = ManiphestTaskPriority::getShortNameMap();
	foreach ($pri_map as $pri => $label) {
	$cname[] = $label;
	$cclass[] = 'n';
	}
	$cname[] = 'Total';
	$cclass[] = 'n';
	$cname[] = javelin_tag(
	'span',
	array(
	'sigil' => 'has-tooltip',
	'meta' => array(
	'tip' => pht('Oldest open task.'),
	'size' => 200,
	),
	),
	pht('Oldest (All)'));
	$cclass[] = 'n';
	$cname[] = javelin_tag(
	'span',
	array(
	'sigil' => 'has-tooltip',
	'meta' => array(
	'tip' => pht('Oldest open task, excluding those with Low or '.
	'Wishlist priority.'),
	'size' => 200,
	),
	),
	pht('Oldest (Pri)'));
	$cclass[] = 'n';

	list($ignored, $window_epoch) = $this->getWindow();
	$edate = phabricator_datetime($window_epoch, $user);
	$cname[] = javelin_tag(
	'span',
	array(
	'sigil' => 'has-tooltip',
	'meta' => array(
	'tip' => pht('Closed after %s', $edate),
	'size' => 260,
	),
	),
	pht('Recently Closed'));
	$cclass[] = 'n';

	$table = new AphrontTableView($rows);
	$table->setHeaders($cname);
	$table->setColumnClasses($cclass);
	$table->makeSortable(
	$request->getRequestURI(),
	'order',
	$order,
	$reverse,
	array(
	'name',
	null,
	null,
	null,
	null,
	null,
	null,
	'total',
	'oldest-all',
	'oldest-pri',
	'closed',
	));

	$panel = new PHUIObjectBoxView();
	$panel->setHeaderText($header);
	$panel->appendChild($table);

	$tokens = array();
	if ($project_handle) {
	$tokens = array($project_handle);
	}
	$filter = $this->renderReportFilters($tokens, $has_window = true);

	return array($filter, $panel);
	}


	/**
	* Load all the tasks that have been recently closed.
	*/
	private function loadRecentlyClosedTasks() {
	list($ignored, $window_epoch) = $this->getWindow();

	$table = new ManiphestTask();
	$xtable = new ManiphestTransaction();
	$conn_r = $table->establishConnection('r');

	// TODO: Gross. This table is not meant to be queried like this. Build
	// real stats tables.

	$open_status_list = array();
	foreach (ManiphestTaskStatus::getOpenStatusConstants() as $constant) {
	$open_status_list[] = json_encode((string)$constant);
	}

	$rows = queryfx_all(
	$conn_r,
	'SELECT t.id FROM %T t JOIN %T x ON x.objectPHID = t.phid
	WHERE t.status NOT IN (%Ls)
	AND x.oldValue IN (null, %Ls)
	AND x.newValue NOT IN (%Ls)
	AND t.dateModified >= %d
	AND x.dateCreated >= %d',
	$table->getTableName(),
	$xtable->getTableName(),
	ManiphestTaskStatus::getOpenStatusConstants(),
	$open_status_list,
	$open_status_list,
	$window_epoch,
	$window_epoch);

	if (!$rows) {
	return array();
	}

	$ids = ipull($rows, 'id');

	$query = id(new ManiphestTaskQuery())
	->setViewer($this->getRequest()->getUser())
	->withIDs($ids);

	switch ($this->view) {
	case 'project':
	$query->needProjectPHIDs(true);
	break;
	}

	return $query->execute();
	}

	/**
	* Parse the "Recently Means" filter into:
	*
	* - A string representation, like "12 AM 7 days ago" (default);
	* - a locale-aware epoch representation; and
	* - a possible error.
	*/
	private function getWindow() {
	$request = $this->getRequest();
	$user = $request->getUser();

	$window_str = $this->getRequest()->getStr('window', '12 AM 7 days ago');

	$error = null;
	$window_epoch = null;

	// Do locale-aware parsing so that the user's timezone is assumed for
	// time windows like "3 PM", rather than assuming the server timezone.

	$window_epoch = PhabricatorTime::parseLocalTime($window_str, $user);
	if (!$window_epoch) {
	$error = 'Invalid';
	$window_epoch = time() - (60 * 60 * 24 * 7);
	}

	// If the time ends up in the future, convert it to the corresponding time
	// and equal distance in the past. This is so users can type "6 days" (which
	// means "6 days from now") and get the behavior of "6 days ago", rather
	// than no results (because the window epoch is in the future). This might
	// be a little confusing because it casues "tomorrow" to mean "yesterday"
	// and "2022" (or whatever) to mean "ten years ago", but these inputs are
	// nonsense anyway.

	if ($window_epoch > time()) {
	$window_epoch = time() - ($window_epoch - time());
	}

	return array($window_str, $window_epoch, $error);
	}

	private function renderOldest(array $tasks) {
	assert_instances_of($tasks, 'ManiphestTask');
	$oldest = null;
	foreach ($tasks as $id => $task) {
	if (($oldest === null) \|\|
	($task->getDateCreated() < $tasks[$oldest]->getDateCreated())) {
	$oldest = $id;
	}
	}

	if ($oldest === null) {
	return array('-', 0);
	}

	$oldest = $tasks[$oldest];

	$raw_age = (time() - $oldest->getDateCreated());
	$age = number_format($raw_age / (24 * 60 * 60)).' d';

	$link = javelin_tag(
	'a',
	array(
	'href' => '/T'.$oldest->getID(),
	'sigil' => 'has-tooltip',
	'meta' => array(
	'tip' => 'T'.$oldest->getID().': '.$oldest->getTitle(),
	),
	'target' => '_blank',
	),
	$age);

	return array($link, $raw_age);
	}

	}

ManiphestReportController.phpNo OneTemporaryActions

File Metadata

ManiphestReportController.phpView Options

Event Timeline

ManiphestReportController.php
No OneTemporary
Actions

ManiphestReportController.php
View Options