Add a guide for SwitchProfile options.

2025-01-22 15:08:12 -05:00 · 2014-11-28 20:23:57 +08:00 · 2014-11-28 20:23:57 +08:00 · 25f27dd1ee
commit 25f27dd1ee
parent 17427ae13f
10 changed files with 249 additions and 35 deletions
--- a/omega-i18n/en/messages.json
+++ b/omega-i18n/en/messages.json
@ -670,6 +670,21 @@
  "options_guide_addMoreProfilesStep": {
    "message": "Need more profiles? You can always add more <b>Proxy, Switch and other profiles</b><br>for all your proxying needs.<br>Enjoy proxying!"
  },
+  "options_guide_conditionStep": {
+    "message": "SwitchyOmega can apply different profiles to requests based on <b>conditions</b>.<br> For example, the <b>Host wildcard</b> condition allows you to set the profile for all URLs in a domain."
+  },
+  "options_guide_conditionTypeStep": {
+    "message": "You can use various condition types to match the host or full URL. <br> Click on the question mark to open the type reference."
+  },
+  "options_guide_conditionProfileStep": {
+    "message": "SwitchyOmega applies the selected profile here to <b>any request matching the condition.</b> <br> The special <b>\"[Direct]\" profile</b> will cause the request to be sent without any proxy."
+  },
+  "options_guide_switchDefaultStep": {
+    "message": "If no condition applies to some request, the \"Default\" profile will be used. <br>Conditions are always considered <b>from top to bottom</b> in order.<br>You can change their order by dragging the sort icon."
+  },
+  "options_guide_applySwitchProfileStep": {
+    "message": "When you are done setting the switch profile, don't forget to <b>switch to it in the popup menu.</b><br/> The icon will show you the <b>final result</b> profile applied for the current tab. <br/> <b>Hovering</b> on the icon will reveal a tooltip with details."
+  },
  "popup_externalProfile": {
    "message": "(External Profile)"
  },
--- a/omega-i18n/zh_CN/messages.json
+++ b/omega-i18n/zh_CN/messages.json
@ -670,6 +670,21 @@
  "options_guide_addMoreProfilesStep": {
    "message": "如果您需要更多的情景模式，可以随时在这里创建<b>代理、切换和其他情景模式</b>。<br>教程到此结束，您可以继续自定义设置。"
  },
+  "options_guide_conditionStep": {
+    "message": "SwitchyOmega 可以根据<b>切换条件</b>对不同的网络请求使用不同的情景模式。<br>例如<b>域名通配符</b>条件可以对某个域名下的所有网址使用特定的情景模式。"
+  },
+  "options_guide_conditionTypeStep": {
+    "message": "您可以使用各种条件类型来匹配域名或者整个网址。<br> 点击问号按钮来查看条件类型的说明。"
+  },
+  "options_guide_conditionProfileStep": {
+    "message": "对于<b>任何匹配该条件的请求</b>，SwitchyOmega 会使用这个情景模式。<br>如果选择了<b>\"[直接连接]\"情景模式</b>，则匹配的请求不使用任何代理。"
+  },
+  "options_guide_switchDefaultStep": {
+    "message": "如果请求不匹配任何条件，则使用默认情景模式。<br>条件的匹配顺序总是按此页面<b>从上到下</b>。<br>您可以拖动排序图标来更改条件的顺序。"
+  },
+  "options_guide_applySwitchProfileStep": {
+    "message": "当您设置完毕后，别忘记<b>在弹出菜单中启用自动切换情景模式</b>。<br/>图标将会显示标签页切换的<b>最终结果</b>情景。<br/> <b>悬停在图标上</b>则会显示切换相关的详细说明。"
+  },
  "popup_externalProfile": {
    "message": "(外部情景模式)"
  },
--- a/omega-i18n/zh_HK/messages.json
+++ b/omega-i18n/zh_HK/messages.json
@ -658,6 +658,33 @@
  "options_downloadProfileNow": {
    "message": "立即更新情景模式"
  },
+  "options_guide_fixedProfileStep": {
+    "message": "<b>代理情景</b>包含了伺服器地址、埠等代理的資訊。<br>在 SwitchyOmega 中，情景模式是代理設定的基本單元。<br>默認設定中已經建立了一個代理情景模式作為樣例。試著開啟它吧。"
+  },
+  "options_guide_fixedServersStep": {
+    "message": "在這裡，您可以填寫所需的代理伺服器地址和埠。<br>SwitchyOmega<b>軟體本身不提供任何內建代理伺服器</b>。<br>如果您不清楚應該填寫什麼，最好諮詢下您的網路提供者，或者參考代理軟體的設定說明。"
+  },
+  "options_guide_autoSwitchProfileStep": {
+    "message": "您可以通過強大的<b>自動切換模式</b>在多個代理間切換自如。<br>不過，在這個簡單的教程中無法詳盡介紹所有功能。<br>想要使用此功能時，可以開啟這裡的設定介面，來瞭解如何使用自動切換功能。"
+  },
+  "options_guide_addMoreProfilesStep": {
+    "message": "如果您需要更多的情景模式，可以隨時在這裡創建<b>代理、切換和其他情景模式</b>。<br>教程到此結束，您可以繼續自定義設定。"
+  },
+  "options_guide_conditionStep": {
+    "message": "SwitchyOmega 可以根據<b>切換條件</b>對不同的網路請求使用不同的情景模式。<br>例如<b>域名通配符</b>條件可以對某個域名下的所有網址使用特定的情景模式。"
+  },
+  "options_guide_conditionTypeStep": {
+    "message": "您可以使用各種條件類型來匹配域名或者整個網址。<br> 點選問號按鈕來檢視條件類型的說明。"
+  },
+  "options_guide_conditionProfileStep": {
+    "message": "對於<b>任何匹配該條件的請求</b>，SwitchyOmega 會使用這個情景模式。<br>如果選擇了<b>\"[直接連線]\"情景模式</b>，則匹配的請求不使用任何代理。"
+  },
+  "options_guide_switchDefaultStep": {
+    "message": "如果請求不匹配任何條件，則使用默認情景模式。<br>條件的匹配順序總是按此頁面<b>從上到下</b>。<br>您可以拖動排序圖示來更改條件的順序。"
+  },
+  "options_guide_applySwitchProfileStep": {
+    "message": "當您設定完畢後，別忘記<b>在彈出選單中啟用自動切換情景模式</b>。<br/>圖示將會顯示標籤頁切換的<b>最終結果</b>情景。<br/> <b>懸停在圖示上</b>則會顯示切換相關的詳細說明。"
+  },
  "popup_externalProfile": {
    "message": "(外部情景模式)"
  },
@ -682,18 +709,6 @@
  "popup_addCondition": {
    "message": "添加條件"
  },
-  "options_guide_fixedProfileStep": {
-    "message": "<b>代理情景</b>包含了伺服器地址、埠等代理的資訊。<br>在 SwitchyOmega 中，情景模式是代理設定的基本單元。<br>默認設定中已經建立了一個代理情景模式作為樣例。試著開啟它吧。"
-  },
-  "options_guide_fixedServersStep": {
-    "message": "在這裡，您可以填寫所需的代理伺服器地址和埠。<br>SwitchyOmega<b>軟體本身不提供任何內建代理伺服器</b>。<br>如果您不清楚應該填寫什麼，最好諮詢下您的網路提供者，或者參考代理軟體的設定說明。"
-  },
-  "options_guide_autoSwitchProfileStep": {
-    "message": "您可以通過強大的<b>自動切換模式</b>在多個代理間切換自如。<br>不過，在這個簡單的教程中無法詳盡介紹所有功能。<br>想要使用此功能時，可以開啟這裡的設定介面，來瞭解如何使用自動切換功能。"
-  },
-  "options_guide_addMoreProfilesStep": {
-    "message": "如果您需要更多的情景模式，可以隨時在這裡創建<b>代理、切換和其他情景模式</b>。<br>教程到此結束，您可以繼續自定義設定。"
-  },
  "popup_showOptions": {
    "message": "選項"
  },
--- a/omega-i18n/zh_TW/messages.json
+++ b/omega-i18n/zh_TW/messages.json
@ -658,6 +658,33 @@
  "options_downloadProfileNow": {
    "message": "立即更新情景模式"
  },
+  "options_guide_fixedProfileStep": {
+    "message": "<b>代理情景</b>包含了伺服器地址、埠等代理的資訊。<br>在 SwitchyOmega 中，情景模式是代理設定的基本單元。<br>默認設定中已經建立了一個代理情景模式作為樣例。試著開啟它吧。"
+  },
+  "options_guide_fixedServersStep": {
+    "message": "在這裡，您可以填寫所需的代理伺服器地址和埠。<br>SwitchyOmega<b>軟體本身不提供任何內建代理伺服器</b>。<br>如果您不清楚應該填寫什麼，最好諮詢下您的網路提供者，或者參考代理軟體的設定說明。"
+  },
+  "options_guide_autoSwitchProfileStep": {
+    "message": "您可以通過強大的<b>自動切換模式</b>在多個代理間切換自如。<br>不過，在這個簡單的教程中無法詳盡介紹所有功能。<br>想要使用此功能時，可以開啟這裡的設定介面，來瞭解如何使用自動切換功能。"
+  },
+  "options_guide_addMoreProfilesStep": {
+    "message": "如果您需要更多的情景模式，可以隨時在這裡創建<b>代理、切換和其他情景模式</b>。<br>教程到此結束，您可以繼續自定義設定。"
+  },
+  "options_guide_conditionStep": {
+    "message": "SwitchyOmega 可以根據<b>切換條件</b>對不同的網路請求使用不同的情景模式。<br>例如<b>域名通配符</b>條件可以對某個域名下的所有網址使用特定的情景模式。"
+  },
+  "options_guide_conditionTypeStep": {
+    "message": "您可以使用各種條件類型來匹配域名或者整個網址。<br> 點選問號按鈕來檢視條件類型的說明。"
+  },
+  "options_guide_conditionProfileStep": {
+    "message": "對於<b>任何匹配該條件的請求</b>，SwitchyOmega 會使用這個情景模式。<br>如果選擇了<b>\"[直接連線]\"情景模式</b>，則匹配的請求不使用任何代理。"
+  },
+  "options_guide_switchDefaultStep": {
+    "message": "如果請求不匹配任何條件，則使用默認情景模式。<br>條件的匹配順序總是按此頁面<b>從上到下</b>。<br>您可以拖動排序圖示來更改條件的順序。"
+  },
+  "options_guide_applySwitchProfileStep": {
+    "message": "當您設定完畢後，別忘記<b>在彈出選單中啟用自動切換情景模式</b>。<br/>圖示將會顯示標籤頁切換的<b>最終結果</b>情景。<br/> <b>懸停在圖示上</b>則會顯示切換相關的詳細說明。"
+  },
  "popup_externalProfile": {
    "message": "(外部情景模式)"
  },
@ -682,18 +709,6 @@
  "popup_addCondition": {
    "message": "添加條件"
  },
-  "options_guide_fixedProfileStep": {
-    "message": "<b>代理情景</b>包含了伺服器地址、埠等代理的資訊。<br>在 SwitchyOmega 中，情景模式是代理設定的基本單元。<br>默認設定中已經建立了一個代理情景模式作為樣例。試著開啟它吧。"
-  },
-  "options_guide_fixedServersStep": {
-    "message": "在這裡，您可以填寫所需的代理伺服器地址和埠。<br>SwitchyOmega<b>軟體本身不提供任何內建代理伺服器</b>。<br>如果您不清楚應該填寫什麼，最好諮詢下您的網路提供者，或者參考代理軟體的設定說明。"
-  },
-  "options_guide_autoSwitchProfileStep": {
-    "message": "您可以通過強大的<b>自動切換模式</b>在多個代理間切換自如。<br>不過，在這個簡單的教程中無法詳盡介紹所有功能。<br>想要使用此功能時，可以開啟這裡的設定介面，來瞭解如何使用自動切換功能。"
-  },
-  "options_guide_addMoreProfilesStep": {
-    "message": "如果您需要更多的情景模式，可以隨時在這裡創建<b>代理、切換和其他情景模式</b>。<br>教程到此結束，您可以繼續自定義設定。"
-  },
  "popup_showOptions": {
    "message": "選項"
  },
--- a/omega-target/src/options.coffee
+++ b/omega-target/src/options.coffee
@ -57,7 +57,7 @@ class Options
      ).catch (ex) =>
        @log.error(ex.stack)
        @reset().tap =>
-          @_state.set({'firstRun': 'new'})
+          @_state.set({'firstRun': 'new', 'web.switchGuide': 'showOnFirstUse'})
    ).then((options) =>
      @_options = options
      @_watch()
--- a/omega-web/src/coffee/popup.coffee
+++ b/omega-web/src/coffee/popup.coffee
@ -45,9 +45,18 @@ module.controller 'PopupCtrl', ($scope, $window, $q, omegaTarget,
  $scope.openConditionHelp = ->
    pname = encodeURIComponent($scope.currentProfileName)
    $scope.openOptions("#/profile/#{pname}?help=condition")
+
  $scope.applyProfile = (profile) ->
-    omegaTarget.applyProfile(profile.name).then ->
-      refresh()
+    omegaTarget.applyProfile(profile.name).then(->
+      if refreshOnProfileChange
+        return omegaTarget.refreshActivePage()
+    ).then(->
+      if profile.profileType == 'SwitchProfile'
+        return omegaTarget.state('web.switchGuide').then (switchGuide) ->
+          if switchGuide == 'showOnFirstUse'
+            return $scope.openOptions("#/profile/#{profile.name}")
+    ).then ->
+      $window.close()

  $scope.tempRuleMenu = {open: false}
  $scope.nameExternal = {open: false}
--- a/omega-web/src/coffee/switch_profile_guide.coffee
+++ b/omega-web/src/coffee/switch_profile_guide.coffee
@ -0,0 +1,74 @@
+$script 'lib/tether/tether.js', ->
+  $script 'lib/shepherd.js/shepherd.min.js', ->
+    tr = chrome.i18n.getMessage.bind(chrome.i18n)
+    tour = new Shepherd.Tour
+      defaults:
+        classes: 'shepherd-theme-arrows'
+        scrollTo: true
+
+    tour.addStep 'condition-step',
+      text: tr('options_guide_conditionStep')
+      attachTo: '.switch-rule-row bottom'
+      scrollTo: true
+      buttons: [
+        {
+          text: tr('options_guideSkip')
+          action: tour.cancel
+          classes: 'shepherd-button-secondary'
+        }
+        {
+          text: tr('options_guideNext')
+          action: tour.next
+        }
+      ]
+
+    conditionTypeStep = tour.addStep('condition-type-step',
+      text: tr('options_guide_conditionTypeStep')
+      attachTo: '.condition-type-th bottom'
+      advanceOn:
+        selector: '.close-condition-help'
+        event: 'click'
+      scrollTo: true
+      buttons: [
+        text: tr('options_guideNext')
+        action: tour.next
+      ]
+    )
+
+    conditionTypeStep.on 'show', ->
+      jQuery('.toggle-condition-help').one 'click', ->
+        return unless conditionTypeStep.isOpen()
+        jQuery('.shepherd-step.shepherd-enabled').hide()
+        jQuery('.toggle-condition-help, .close-condition-help').one 'click', ->
+          tour.next()
+
+    tour.addStep 'condition-profile-step',
+      text: tr('options_guide_conditionProfileStep')
+      attachTo: '.switch-rule-row-target bottom'
+      scrollTo: true
+      buttons: [
+        text: tr('options_guideNext')
+        action: tour.next
+      ]
+
+    tour.addStep 'switch-default-step',
+      text: tr('options_guide_switchDefaultStep')
+      attachTo: '.switch-default-row top'
+      scrollTo: true
+      buttons: [
+        text: tr('options_guideNext')
+        action: tour.next
+      ]
+
+    tour.addStep 'apply-switch-profile-step',
+      text: tr('options_guide_applySwitchProfileStep')
+      attachTo: 'body top'
+      scrollTo: false
+      classes: 'shepherd-theme-arrows fixed-top-right'
+      buttons: [
+        text: tr('options_guideDone')
+        action: tour.next
+      ]
+
+    Shepherd.activeTour?.cancel()
+    tour.start()
--- a/omega-web/src/less/options.less
+++ b/omega-web/src/less/options.less
@ -80,6 +80,50 @@ ul.list-style-none, li.list-style-none {
    z-index: 10;
  }

+  .switch-rules {
+    position: relative;
+    background-color: #7f7f7f;
+    z-index: 11;
+
+    &, th, td, tbody {
+      border-color: #6e6e6e !important;
+    }
+
+    .btn {
+      opacity: .5;
+    }
+
+    .form-control, .btn-default {
+      background-color: #7f7f7f;
+      border-color: #6e6e6e;
+      opacity: 1;
+    }
+
+    .shepherd-enabled {
+      background-color: #fff;
+      border-color: #ddd !important;
+      &, td, tbody {
+        border-color: #ddd !important;
+      }
+
+      .btn {
+        opacity: 1;
+      }
+
+      .form-control, .btn-default {
+        background-color: #fff;
+        border-color: #ddd;
+      }
+    }
+
+  }
+
+  .condition-help-section {
+    position: relative;
+    z-index: 11;
+    background-color: #fff;
+  }
+
  &:not([data-shepherd-step="fixed-servers-step"]) {
    .side-nav {
      position: absolute;
@ -92,6 +136,14 @@ ul.list-style-none, li.list-style-none {
      background-color: #fff;
    }
  }
+
+  &[data-shepherd-step="switch-default-step"] {
+    .sort-bar {
+      position: relative;
+      z-index: 11;
+      background-color: #ffc;
+    }
+  }
 }

 .shepherd-enabled {
@ -103,6 +155,15 @@ ul.list-style-none, li.list-style-none {
  }
 }

+.fixed-top-right {
+  position: fixed !important;
+  top: 0 !important;
+  right: 0 !important;
+  left: auto !important;
+  bottom: auto !important;
+  transform: none !important;
+}
+
 /* alert */

 .alert-top-wrapper {
--- a/omega-web/src/omega/controllers/switch_profile.coffee
+++ b/omega-web/src/omega/controllers/switch_profile.coffee
@ -1,5 +1,5 @@
 angular.module('omega').controller 'SwitchProfileCtrl', ($scope, $location,
-  $modal, profileIcons, getAttachedName) ->
+  $modal, profileIcons, getAttachedName, omegaTarget) ->

  $scope.showConditionHelp = ($location.search().help == 'condition')

@ -212,3 +212,12 @@ angular.module('omega').controller 'SwitchProfileCtrl', ($scope, $location,
    ).result.then ->
      $scope.profile.defaultProfileName = $scope.attached.defaultProfileName
      delete $scope.options[$scope.attachedKey]
+
+  stopWatchingForGuide = $scope.$watch 'profile.rules', (rules) ->
+    return unless rules
+    stopWatchingForGuide()
+    omegaTarget.state(['web.switchGuide', 'firstRun'
+    ]).then ([switchGuide, firstRun]) ->
+      return if firstRun or switchGuide == 'shown'
+      $script 'js/switch_profile_guide.js'
+      omegaTarget.state('web.switchGuide', 'shown')
--- a/omega-web/src/partials/profile_switch.jade
+++ b/omega-web/src/partials/profile_switch.jade
@ -1,5 +1,5 @@
 div(ng-controller='SwitchProfileCtrl')
-  section.settings-group(ng-show='showConditionHelp' ng-init='expandedSection = {id: 0}')
+  section.condition-help-section.settings-group(ng-show='showConditionHelp' ng-init='expandedSection = {id: 0}')
    h3
      | {{'options_group_conditionHelp' | tr}}
      button.close.close-condition-help(type='button' ng-click='showConditionHelp = false')
@ -16,22 +16,23 @@ div(ng-controller='SwitchProfileCtrl')
        dd(ng-repeat-end ng-bind-html='"condition_help_" + type | tr')
  section.settings-group
    h3 {{'options_group_switchRules' | tr}}
-    .table-responsive
+    .table-responsive.switch-rules-wrapper
      table.switch-rules.table.table-bordered.table-condensed.width-limit-xl
        thead
          tr
            th(style='white-space: nowrap') {{'options_sort' | tr}}
-            th
+            th.condition-type-th
              | {{'options_conditionType' | tr}}
              = ' '
-              button.btn.btn-link.btn-sm.clear-padding(title='{{"options_showConditionTypeHelp" | tr}}'
+              button.btn.btn-link.btn-sm.clear-padding.toggle-condition-help(
+                title='{{"options_showConditionTypeHelp" | tr}}'
                ng-click='showConditionHelp = !showConditionHelp')
                span.glyphicon.glyphicon-question-sign
            th {{'options_conditionDetails' | tr}}
            th {{'options_resultProfile' | tr}}
            th {{'options_conditionActions' | tr}}
        tbody(ui-sortable='sortableOptions' ng-model='profile.rules')
-          tr(ng-repeat='rule in profile.rules')
+          tr.switch-rule-row(ng-repeat='rule in profile.rules')
            td.sort-bar
              span.glyphicon.glyphicon-sort
            td
@ -50,7 +51,7 @@ div(ng-controller='SwitchProfileCtrl')
                input.form-control(type='number' max='99' min='1' ng-model='rule.condition.maxValue' required)
              input.form-control(ng-model='rule.condition.pattern' ng-switch-default required
                ui-validate='{pattern: "validateCondition(rule.condition, $value)"}')
-            td
+            td.switch-rule-row-target
              div(omega-profile-select='options | profiles:profile' ng-model='rule.profileName'
                disp-name='dispNameFilter' options='options'
                ng-class='{disabled: rule.condition.conditionType == "NeverCondition"}')
@ -86,7 +87,7 @@ div(ng-controller='SwitchProfileCtrl')
              button.btn.btn-danger.btn-sm(title="{{'options_deleteAttached' | tr}}" ng-click='removeAttached()')
                span.glyphicon.glyphicon-trash
        tbody
-          tr
+          tr.switch-default-row
            td
            td(colspan='2') {{'options_switchDefaultProfile' | tr}}
            td