From 461066cab90ffe00f8c17a09bd15721feee78728 Mon Sep 17 00:00:00 2001
From: Brock Whittaker <brock@zulipchat.com>
Date: Tue, 21 Feb 2017 09:13:32 -0800
Subject: [PATCH] Add deep linking to #subscriptions/new and
 #subscriptions/:stream_id.

This mechanism allows for a user to deep link to a particular
subscription or the form for creating a new subscription.
---
 static/js/click_handlers.js     |  4 +--
 static/js/hashchange.js         | 13 +++++++++-
 static/js/subs.js               | 46 ++++++++++++++++++++++++++++++++-
 static/styles/subscriptions.css |  1 +
 4 files changed, 60 insertions(+), 4 deletions(-)

diff --git a/static/js/click_handlers.js b/static/js/click_handlers.js
index 8f3f0d96b8..3a6236df06 100644
--- a/static/js/click_handlers.js
+++ b/static/js/click_handlers.js
@@ -387,8 +387,8 @@ $(function () {
     $("#join_unsub_stream").click(function (e) {
         e.preventDefault();
         e.stopPropagation();
-        subs.launch();
-        components.toggle.lookup("stream-filter-toggle").goto("All streams");
+
+        window.location.hash = "subscriptions/new";
     });
 
     // FEEDBACK
diff --git a/static/js/hashchange.js b/static/js/hashchange.js
index 6a1d8946c1..5f60dfd2e0 100644
--- a/static/js/hashchange.js
+++ b/static/js/hashchange.js
@@ -221,6 +221,15 @@ function get_main_hash(hash) {
     return hash ? hash.replace(/^#/, "").split(/\//)[0] : "";
 }
 
+function get_hash_components() {
+    var hash = window.location.hash.split(/\//);
+
+    return {
+        base: hash.shift(),
+        arguments: hash,
+    };
+}
+
 // different groups require different reloads. The grouped elements don't
 // require a reload or overlay change to run.
 var get_hash_group = (function () {
@@ -277,7 +286,7 @@ function hashchanged(from_reload, e) {
             }
 
             if (base === "subscriptions") {
-                subs.launch();
+                subs.launch(get_hash_components());
             } else if (base === "drafts") {
                 drafts.launch();
             } else if (/settings|administration/.test(base)) {
@@ -286,6 +295,8 @@ function hashchanged(from_reload, e) {
             }
 
             ignore.group = get_hash_group(base);
+        } else {
+            subs.change_state(get_hash_components());
         }
     } else if (!should_ignore(window.location.hash) && !ignore.flag) {
         exports.close_modals();
diff --git a/static/js/subs.js b/static/js/subs.js
index 71fe62cb14..c1a7838fcf 100644
--- a/static/js/subs.js
+++ b/static/js/subs.js
@@ -724,10 +724,44 @@ exports.onlaunchtrigger = function () {
     }
 };
 
-exports.launch = function () {
+exports.change_state = (function () {
+    var prevent_next = false;
+
+    var func = function (hash) {
+        if (prevent_next) {
+            prevent_next = false;
+            return;
+        }
+
+        // if there are any arguments the state should be modified.
+        if (hash.arguments.length > 0) {
+            // if in #subscriptions/new form.
+            if (hash.arguments[0] === "new") {
+                $("#create_stream_button").click();
+                components.toggle.lookup("stream-filter-toggle").goto("All streams");
+            // if the first argument is a valid number.
+            } else if (/\d+/.test(hash.arguments[0])) {
+                var $stream_row = $(".stream-row[data-stream-id='" + hash.arguments[0] + "']");
+                var top = $stream_row.click()[0].offsetTop;
+
+                $(".streams-list").animate({ scrollTop: top }, 200);
+            }
+        }
+    };
+
+    func.prevent_once = function () {
+        prevent_next = true;
+    };
+
+    return func;
+}());
+
+exports.launch = function (hash) {
     meta.is_open = true;
     exports.setup_page(function () {
         $("#subscription_overlay").addClass("show");
+
+        exports.change_state(hash);
     });
 };
 
@@ -1035,6 +1069,11 @@ $(function () {
         if (window.innerWidth > 700) {
             $('#create_stream_name').focus();
         }
+
+        // change the hash to #subscriptions/new to allow for linking and
+        // easy discovery.
+
+        window.location.hash = "#subscriptions/new";
     });
 
     $('body').on('change', '#user-checkboxes input, #make-invite-only input', update_announce_stream_state);
@@ -1328,6 +1367,11 @@ $(function () {
     $("#subscriptions_table").on("click", ".stream-row", function (e) {
         if ($(e.target).closest(".check, .subscription_settings").length === 0) {
             show_stream_row(this, e);
+            exports.change_state.prevent_once();
+
+            window.location.hash = "#subscriptions" + "/" +
+                $(this).attr("data-stream-id") + "/" +
+                hashchange.encodeHashComponent($(this).attr("data-stream-name"));
         }
     });
 
diff --git a/static/styles/subscriptions.css b/static/styles/subscriptions.css
index 9925d10c67..dad3bd86c1 100644
--- a/static/styles/subscriptions.css
+++ b/static/styles/subscriptions.css
@@ -555,6 +555,7 @@ form#add_new_subscription {
 }
 
 .streams-list {
+    position: relative;
     overflow: auto;
     height: calc(100% - 45px);
     width: 100%;