Provide basic structure for keyboard shortcuts

Summary: Implements a simple infrastructure for keyboard shortcuts, see T184, and a "help" shortcut.

There's a lot of room for refinement here but I think it basically works. Each shortcut can also provide a "tooltip" handler which allows it to show help when the alt/option key is held down.

Test Plan: Pressed "?" and got help. Pressed "?" in various contexts where it should not activate (modifier keys, text input focused) and didn't get help.

Reviewers: aran, tuomaspelkonen, jungejason

CC: moskov

Differential Revision: 362

Author: epriestley

scripts/celerity_mapper.php

@@ -27,6 +27,10 @@
     'javelin-mask',
     'javelin-workflow',
     'javelin-behavior-workflow',
+    'javelin-behavior-aphront-form-disable-on-submit',
+    'phabricator-keyboard-shortcut-manager',
+    'phabricator-keyboard-shortcut',
+    'javelin-behavior-phabricator-keyboard-shortcuts',
   ),
   'core.pkg.css' => array(
     'phabricator-core-css',

src/__celerity_resource_map__.php

@@ -188,24 +188,24 @@
     ),
     'disk' => '/rsrc/css/application/differential/revision-comment-list.css',
   ),
-  0 =>
+  'differential-revision-detail-css' =>
   array(
-    'uri' => '/res/39de799e/rsrc/js/javelin/docs/Base.js',
-    'type' => 'js',
+    'uri' => '/res/ea9de420/rsrc/css/application/differential/revision-detail.css',
+    'type' => 'css',
     'requires' =>
     array(
-      0 => 'javelin-install',
     ),
-    'disk' => '/rsrc/js/javelin/docs/Base.js',
+    'disk' => '/rsrc/css/application/differential/revision-detail.css',
   ),
-  'differential-revision-detail-css' =>
+  0 =>
   array(
-    'uri' => '/res/ea9de420/rsrc/css/application/differential/revision-detail.css',
-    'type' => 'css',
+    'uri' => '/res/39de799e/rsrc/js/javelin/docs/Base.js',
+    'type' => 'js',
     'requires' =>
     array(
+      0 => 'javelin-install',
     ),
-    'disk' => '/rsrc/css/application/differential/revision-detail.css',
+    'disk' => '/rsrc/js/javelin/docs/Base.js',
   ),
   'differential-revision-history-css' =>
   array(
@@ -546,6 +546,19 @@
     ),
     'disk' => '/rsrc/js/application/owners/owners-path-editor.js',
   ),
+  'javelin-behavior-phabricator-keyboard-shortcuts' =>
+  array(
+    'uri' => '/res/5a23bcc8/rsrc/js/application/core/behavior-keyboard-shortcuts.js',
+    'type' => 'js',
+    'requires' =>
+    array(
+      0 => 'javelin-behavior',
+      1 => 'javelin-workflow',
+      2 => 'javelin-json',
+      3 => 'phabricator-keyboard-shortcut',
+    ),
+    'disk' => '/rsrc/js/application/core/behavior-keyboard-shortcuts.js',
+  ),
   'javelin-behavior-phabricator-object-selector' =>
   array(
     'uri' => '/res/12d4d90d/rsrc/js/application/core/behavior-object-selector.js',
@@ -923,6 +936,31 @@
     ),
     'disk' => '/rsrc/js/application/core/DragAndDropFileUpload.js',
   ),
+  'phabricator-keyboard-shortcut' =>
+  array(
+    'uri' => '/res/beed38cd/rsrc/js/application/core/KeyboardShortcut.js',
+    'type' => 'js',
+    'requires' =>
+    array(
+      0 => 'javelin-install',
+      1 => 'javelin-util',
+      2 => 'phabricator-keyboard-shortcut-manager',
+    ),
+    'disk' => '/rsrc/js/application/core/KeyboardShortcut.js',
+  ),
+  'phabricator-keyboard-shortcut-manager' =>
+  array(
+    'uri' => '/res/b32845bd/rsrc/js/application/core/KeyboardShortcutManager.js',
+    'type' => 'js',
+    'requires' =>
+    array(
+      0 => 'javelin-install',
+      1 => 'javelin-util',
+      2 => 'javelin-stratcom',
+      3 => 'javelin-dom',
+    ),
+    'disk' => '/rsrc/js/application/core/KeyboardShortcutManager.js',
+  ),
   'phabricator-object-selector-css' =>
   array(
     'uri' => '/res/ced4098a/rsrc/css/application/objectselector/object-selector.css',
@@ -965,7 +1003,7 @@
   ),
   'phabricator-standard-page-view' =>
   array(
-    'uri' => '/res/4db19fcb/rsrc/css/application/base/standard-page-view.css',
+    'uri' => '/res/02ae6920/rsrc/css/application/base/standard-page-view.css',
     'type' => 'css',
     'requires' =>
     array(
@@ -1003,18 +1041,6 @@
       'uri' => '/res/pkg/03ef179e/diffusion.pkg.css',
       'type' => 'css',
     ),
-    '122a6b6d' =>
-    array (
-      'name' => 'workflow.pkg.js',
-      'symbols' =>
-      array (
-        0 => 'javelin-mask',
-        1 => 'javelin-workflow',
-        2 => 'javelin-behavior-workflow',
-      ),
-      'uri' => '/res/pkg/122a6b6d/workflow.pkg.js',
-      'type' => 'js',
-    ),
     '33f413ef' =>
     array (
       'name' => 'typeahead.pkg.js',
@@ -1048,7 +1074,7 @@
       'uri' => '/res/pkg/613cf273/differential.pkg.css',
       'type' => 'css',
     ),
-    'c9c3eee2' =>
+    '64383b02' =>
     array (
       'name' => 'core.pkg.css',
       'symbols' =>
@@ -1069,7 +1095,7 @@
         13 => 'phabricator-remarkup-css',
         14 => 'syntax-highlighting-css',
       ),
-      'uri' => '/res/pkg/c9c3eee2/core.pkg.css',
+      'uri' => '/res/pkg/64383b02/core.pkg.css',
       'type' => 'css',
     ),
     'db95a6d0' =>
@@ -1091,6 +1117,22 @@
       'uri' => '/res/pkg/db95a6d0/javelin.pkg.js',
       'type' => 'js',
     ),
+    'e26c5e06' =>
+    array (
+      'name' => 'workflow.pkg.js',
+      'symbols' =>
+      array (
+        0 => 'javelin-mask',
+        1 => 'javelin-workflow',
+        2 => 'javelin-behavior-workflow',
+        3 => 'javelin-behavior-aphront-form-disable-on-submit',
+        4 => 'phabricator-keyboard-shortcut-manager',
+        5 => 'phabricator-keyboard-shortcut',
+        6 => 'javelin-behavior-phabricator-keyboard-shortcuts',
+      ),
+      'uri' => '/res/pkg/e26c5e06/workflow.pkg.js',
+      'type' => 'js',
+    ),
     'ed383f69' =>
     array (
       'name' => 'differential.pkg.js',
@@ -1108,15 +1150,15 @@
   ),
   'reverse' =>
   array (
-    'aphront-crumbs-view-css' => 'c9c3eee2',
-    'aphront-dialog-view-css' => 'c9c3eee2',
-    'aphront-form-view-css' => 'c9c3eee2',
-    'aphront-list-filter-view-css' => 'c9c3eee2',
-    'aphront-panel-view-css' => 'c9c3eee2',
-    'aphront-side-nav-view-css' => 'c9c3eee2',
-    'aphront-table-view-css' => 'c9c3eee2',
-    'aphront-tokenizer-control-css' => 'c9c3eee2',
-    'aphront-typeahead-control-css' => 'c9c3eee2',
+    'aphront-crumbs-view-css' => '64383b02',
+    'aphront-dialog-view-css' => '64383b02',
+    'aphront-form-view-css' => '64383b02',
+    'aphront-list-filter-view-css' => '64383b02',
+    'aphront-panel-view-css' => '64383b02',
+    'aphront-side-nav-view-css' => '64383b02',
+    'aphront-table-view-css' => '64383b02',
+    'aphront-tokenizer-control-css' => '64383b02',
+    'aphront-typeahead-control-css' => '64383b02',
     'differential-changeset-view-css' => '613cf273',
     'differential-core-view-css' => '613cf273',
     'differential-revision-add-comment-css' => '613cf273',
@@ -1128,17 +1170,19 @@
     'diffusion-commit-view-css' => '03ef179e',
     'javelin-behavior' => 'db95a6d0',
     'javelin-behavior-aphront-basic-tokenizer' => '33f413ef',
+    'javelin-behavior-aphront-form-disable-on-submit' => 'e26c5e06',
     'javelin-behavior-differential-diff-radios' => 'ed383f69',
     'javelin-behavior-differential-edit-inline-comments' => 'ed383f69',
     'javelin-behavior-differential-feedback-preview' => 'ed383f69',
     'javelin-behavior-differential-populate' => 'ed383f69',
     'javelin-behavior-differential-show-more' => 'ed383f69',
-    'javelin-behavior-workflow' => '122a6b6d',
+    'javelin-behavior-phabricator-keyboard-shortcuts' => 'e26c5e06',
+    'javelin-behavior-workflow' => 'e26c5e06',
     'javelin-dom' => 'db95a6d0',
     'javelin-event' => 'db95a6d0',
     'javelin-install' => 'db95a6d0',
     'javelin-json' => 'db95a6d0',
-    'javelin-mask' => '122a6b6d',
+    'javelin-mask' => 'e26c5e06',
     'javelin-request' => 'db95a6d0',
     'javelin-stratcom' => 'db95a6d0',
     'javelin-tokenizer' => '33f413ef',
@@ -1150,12 +1194,14 @@
     'javelin-uri' => 'db95a6d0',
     'javelin-util' => 'db95a6d0',
     'javelin-vector' => 'db95a6d0',
-    'javelin-workflow' => '122a6b6d',
-    'phabricator-core-buttons-css' => 'c9c3eee2',
-    'phabricator-core-css' => 'c9c3eee2',
-    'phabricator-directory-css' => 'c9c3eee2',
-    'phabricator-remarkup-css' => 'c9c3eee2',
-    'phabricator-standard-page-view' => 'c9c3eee2',
-    'syntax-highlighting-css' => 'c9c3eee2',
+    'javelin-workflow' => 'e26c5e06',
+    'phabricator-core-buttons-css' => '64383b02',
+    'phabricator-core-css' => '64383b02',
+    'phabricator-directory-css' => '64383b02',
+    'phabricator-keyboard-shortcut' => 'e26c5e06',
+    'phabricator-keyboard-shortcut-manager' => 'e26c5e06',
+    'phabricator-remarkup-css' => '64383b02',
+    'phabricator-standard-page-view' => '64383b02',
+    'syntax-highlighting-css' => '64383b02',
   ),
 ));

src/__phutil_library_map__.php

@@ -330,6 +330,8 @@
     'PhabricatorFileViewController' => 'applications/files/controller/view',
     'PhabricatorGoodForNothingWorker' => 'infrastructure/daemon/workers/worker/goodfornothing',
     'PhabricatorHandleObjectSelectorDataView' => 'applications/phid/handle/view/selector',
+    'PhabricatorHelpController' => 'applications/help/controller/base',
+    'PhabricatorHelpKeyboardShortcutController' => 'applications/help/controller/keyboardshortcut',
     'PhabricatorIRCBot' => 'infrastructure/daemon/irc/bot',
     'PhabricatorIRCHandler' => 'infrastructure/daemon/irc/handler/base',
     'PhabricatorIRCMessage' => 'infrastructure/daemon/irc/message',
@@ -777,6 +779,8 @@
     'PhabricatorFileUploadController' => 'PhabricatorFileController',
     'PhabricatorFileViewController' => 'PhabricatorFileController',
     'PhabricatorGoodForNothingWorker' => 'PhabricatorWorker',
+    'PhabricatorHelpController' => 'PhabricatorController',
+    'PhabricatorHelpKeyboardShortcutController' => 'PhabricatorHelpController',
     'PhabricatorIRCBot' => 'PhabricatorDaemon',
     'PhabricatorIRCObjectNameHandler' => 'PhabricatorIRCHandler',
     'PhabricatorIRCProtocolHandler' => 'PhabricatorIRCHandler',

src/aphront/default/configuration/AphrontDefaultApplicationConfiguration.php

@@ -305,6 +305,9 @@ public function getURIMap() {
 
       '/status/$' => 'PhabricatorStatusController',
 
+      '/help/' => array(
+        'keyboardshortcut/$' => 'PhabricatorHelpKeyboardShortcutController',
+      ),
     );
   }
 

src/applications/help/controller/base/PhabricatorHelpController.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * Copyright 2011 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+abstract class PhabricatorHelpController extends PhabricatorController {
+
+  public function buildStandardPageResponse($view, array $data) {
+    $page = $this->buildStandardPageView();
+
+    $page->setApplicationName('Help');
+    $page->setBaseURI('/help/');
+    $page->setTitle(idx($data, 'title'));
+    $page->setGlyph('?');
+    $page->appendChild($view);
+
+    $response = new AphrontWebpageResponse();
+    return $response->setContent($page->render());
+  }
+
+}

src/applications/help/controller/base/__init__.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * This file is automatically generated. Lint this module to rebuild it.
+ * @generated
+ */
+
+
+
+phutil_require_module('phabricator', 'aphront/response/webpage');
+phutil_require_module('phabricator', 'applications/base/controller/base');
+
+phutil_require_module('phutil', 'utils');
+
+
+phutil_require_source('PhabricatorHelpController.php');

src/applications/help/controller/keyboardshortcut/PhabricatorHelpKeyboardShortcutController.php

@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * Copyright 2011 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+class PhabricatorHelpKeyboardShortcutController
+  extends PhabricatorHelpController {
+
+  public function processRequest() {
+    $request = $this->getRequest();
+    $user = $request->getUser();
+
+    $keys = $request->getStr('keys');
+    $keys = json_decode($keys, true);
+    if (!is_array($keys)) {
+      return new Aphront400Response();
+    }
+
+    $rows = array();
+    foreach ($keys as $shortcut) {
+      $keystrokes = array();
+      foreach ($shortcut['keys'] as $stroke) {
+        $keystrokes[] = '<kbd>'.phutil_escape_html($stroke).'</kbd>';
+      }
+      $keystrokes = implode(' or ', $keystrokes);
+      $rows[] =
+        '<tr>'.
+          '<th>'.$keystrokes.'</th>'.
+          '<td>'.phutil_escape_html($shortcut['description']).'</td>'.
+        '</tr>';
+    }
+
+    $table =
+      '<table class="keyboard-shortcut-help">'.
+        implode('', $rows).
+      '</table>';
+
+    $dialog = id(new AphrontDialogView())
+      ->setUser($user)
+      ->setTitle('Keyboard Shortcuts')
+      ->appendChild($table)
+      ->addCancelButton('#', 'Close');
+
+    return id(new AphrontDialogResponse())
+      ->setDialog($dialog);
+  }
+
+}

src/applications/help/controller/keyboardshortcut/__init__.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * This file is automatically generated. Lint this module to rebuild it.
+ * @generated
+ */
+
+
+
+phutil_require_module('phabricator', 'aphront/response/400');
+phutil_require_module('phabricator', 'aphront/response/dialog');
+phutil_require_module('phabricator', 'applications/help/controller/base');
+phutil_require_module('phabricator', 'view/dialog');
+
+phutil_require_module('phutil', 'markup');
+phutil_require_module('phutil', 'utils');
+
+
+phutil_require_source('PhabricatorHelpKeyboardShortcutController.php');