From: Michael Kaply <consulting@kaply.com>
Date: Wed, 11 Apr 2018 15:24:49 +0000 (-0500)
Subject: Merge pull request #62 from mozilla/SearchEngines_Policy
X-Git-Tag: 0.9~8
X-Git-Url: https://git.p6c8.net/policy-templates.git/commitdiff_plain/23f77b2cefd0c8d02f6aef2232efaac64718c8ca?hp=5b9cf156d0ceaf337241234c5509fcf39cc7f363

Merge pull request #62 from mozilla/SearchEngines_Policy

Add policies for SearchEngines
---

diff --git a/README.md b/README.md
index 9938b1a..2277853 100644
--- a/README.md
+++ b/README.md
@@ -405,12 +405,13 @@ same folder name are grouped together.
 {
   "policies": {
     "Bookmarks": [
-    {"Title": "Example",
-     "URL": "http://example.org",
-     "Favicon": "http://example.com/favicon.ico",
-     "Placement": ["toolbar", "menu"],
-     "Folder": "FolderName"
-     }
+      {
+        "Title": "Example",
+        "URL": "http://example.org",
+        "Favicon": "http://example.com/favicon.ico",
+        "Placement": ["toolbar", "menu"],
+        "Folder": "FolderName"
+      }
     ]
   }
 }
@@ -464,3 +465,26 @@ Blocks websites from being visited. The parameters take an array of Match Patter
   }
 }
 ```
+### Search Engines
+This policy allows you to add new search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
+```
+{
+  "policies": {
+    "SearchEngines": {
+      "Add": [
+        {
+          "Name": "",
+          "URLTemplate": "URL including {searchTerms} to substitute for the terms",
+          "Method": ["GET", "POST"],
+          "IconURL": "URL to icon",
+          "Alias": "Alias that can be used to access the engine",
+          "Description": "Description",
+          "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
+        }
+      ],
+      "Default": "Name of engine",
+      "PreventInstalls": [true|false]
+    }
+  }
+}
+```
\ No newline at end of file
diff --git a/windows/en-US/firefox.adml b/windows/en-US/firefox.adml
index 6e9bfe9..ea66f2e 100644
--- a/windows/en-US/firefox.adml
+++ b/windows/en-US/firefox.adml
@@ -16,6 +16,7 @@
       <string id="Extensions_group">Extensions</string>
       <string id="Flash_group">Flash</string>
       <string id="Homepage_group">Home page</string>
+      <string id="Search_group">Search</string>
       <string id="Allow">Allowed Sites</string>
       <string id="Block">Blocked Sites</string>
       <string id="Authentication_SPNEGO">SPNEGO</string>
@@ -233,8 +234,26 @@ If this policy is enabled, private browsing is enabled by default in both the br
       <string id="SearchBar_Explain">If this policy is enabled, you can set whether the search bar is separate from the URL bar.
 
 If this policy is not configured or disabled, new users get a unified search bar, users upgrading from Firefox 56 and below get a separate search bar.</string>
+      <string id="SearchEngines_1">Search Engine One</string>
+      <string id="SearchEngines_2">Search Engine Two</string>
+      <string id="SearchEngines_3">Search Engine Three</string>
+      <string id="SearchEngines_4">Search Engine Four</string>
+      <string id="SearchEngines_5">Search Engine Five</string>
+      <string id="SearchEngines_Explain">If this policy is enabled, you can configure a search engine to be added to Firefox. Use {searchTerms} to indicate where the search term is placed. Due to a bug, you must select the method (usually GET). Note that you must specify the search engines in order.
+
+If this policy is not configured or disabled, a new search engine is not added.</string>
       <string id="SearchBar_Unified">Unified</string>
       <string id="SearchBar_Separate">Separate</string>
+      <string id="SearchEngine_Method_GET">GET</string>
+      <string id="SearchEngine_Method_POST">POST</string>
+      <string id="SearchEngines_Default">Default Search Engine</string>
+      <string id="SearchEngines_Default_Explain">If this policy is enabled, you can set type the name of a search engine to be used as the default.
+
+If this policy is not configured or disabled, the Firefox default engine is used.</string>
+      <string id="SearchEngines_PreventInstalls">Prevent Search Engine Installs</string>
+      <string id="SearchEngines_PreventInstalls_Explain">If this policy is enabled, the user cannot install search engines from web page.
+
+If this policy is not configured or disabled, search engines can be installed from web pages.</string>
     </stringTable>
     <presentationTable>
       <presentation id="Authentication">
@@ -292,6 +311,33 @@ If this policy is not configured or disabled, new users get a unified search bar
           <label/>
         </textBox>
       </presentation>
+      <presentation id="SearchEngine">
+        <textBox refId="SearchEngine_Name">
+          <label>Name:</label>
+        </textBox>
+        <textBox refId="SearchEngine_URLTemplate">
+          <label>URL Template:</label>
+        </textBox>
+        <text>Method:</text>
+        <dropdownList refId="SearchEngine_Method"/>
+        <textBox refId="SearchEngine_IconURL">
+          <label>Icon URL:</label>
+        </textBox>
+        <textBox refId="SearchEngine_Alias">
+          <label>Alias:</label>
+        </textBox>
+        <textBox refId="SearchEngine_Description">
+          <label>Description:</label>
+        </textBox>
+        <textBox refId="SearchEngine_SuggestURLTemplate">
+          <label>Suggest URL Template:</label>
+        </textBox>
+      </presentation>
+      <presentation id="SearchEngines_Default">
+        <textBox refId="SearchEngines_Default">
+          <label/>
+        </textBox>
+      </presentation>
       <presentation id="Proxy">
         <checkBox refId="ProxyLocked">Don't allow proxy settings to be changed.</checkBox>
         <text>Connection Type:</text>
diff --git a/windows/firefox.admx b/windows/firefox.admx
index 93832ec..5e153a1 100644
--- a/windows/firefox.admx
+++ b/windows/firefox.admx
@@ -45,6 +45,9 @@
     <category displayName="$(string.Extensions_group)" name="Extensions">
       <parentCategory ref="firefox"/>
     </category>
+    <category displayName="$(string.Search_group)" name="Search">
+      <parentCategory ref="firefox"/>
+    </category>
   </categories>
   <policies>
     <policy name="Authentication_SPNEGO" class="Both" displayName="$(string.Authentication_SPNEGO)"  key="Software\Policies\Mozilla\Firefox\Authentication\SPNEGO" explainText="$(string.Authentication_SPNEGO_Explain)" presentation="$(presentation.Authentication)">
@@ -815,5 +818,142 @@
         <list id="WebsiteFilter" key="Software\Policies\Mozilla\Firefox\WebsiteFilter\Exceptions" valuePrefix=""/>
       </elements>
     </policy>
+    <policy name="SearchEngines_1" class="Both" displayName="$(string.SearchEngines_1)" explainText="$(string.SearchEngines_Explain)" key="Software\Policies\Mozilla\Firefox\SearchEngines\Add\1" presentation="$(presentation.SearchEngine)" >
+      <parentCategory ref="Search" />
+      <supportedOn ref="SUPPORTED_WINXPSP2" />
+      <elements >
+        <text id="SearchEngine_Name" valueName="Name" required="true" />
+        <text id="SearchEngine_URLTemplate" valueName="URLTemplate" required="true" />
+        <enum id="SearchEngine_Method" valueName="Method">
+          <item displayName="$(string.SearchEngine_Method_GET)">
+            <value>
+              <string>GET</string>
+            </value>
+          </item>
+          <item displayName="$(string.SearchEngine_Method_POST)">
+            <value>
+              <string>POST</string>
+            </value>
+          </item>
+        </enum>
+        <text id="SearchEngine_IconURL" valueName="IconURL"/>
+        <text id="SearchEngine_Alias" valueName="Alias"/>
+        <text id="SearchEngine_Description" valueName="Description"/>
+        <text id="SearchEngine_SuggestURLTemplate" valueName="SuggestURLTemplate"/>
+      </elements>
+    </policy>
+    <policy name="SearchEngines_2" class="Both" displayName="$(string.SearchEngines_2)" explainText="$(string.SearchEngines_Explain)" key="Software\Policies\Mozilla\Firefox\SearchEngines\Add\2" presentation="$(presentation.SearchEngine)" >
+      <parentCategory ref="Search" />
+      <supportedOn ref="SUPPORTED_WINXPSP2" />
+      <elements >
+        <text id="SearchEngine_Name" valueName="Name" required="true" />
+        <text id="SearchEngine_URLTemplate" valueName="URLTemplate" required="true" />
+        <enum id="SearchEngine_Method" valueName="Method">
+          <item displayName="$(string.SearchEngine_Method_GET)">
+            <value>
+              <string>GET</string>
+            </value>
+          </item>
+          <item displayName="$(string.SearchEngine_Method_POST)">
+            <value>
+              <string>POST</string>
+            </value>
+          </item>
+        </enum>
+        <text id="SearchEngine_IconURL" valueName="IconURL"/>
+        <text id="SearchEngine_Alias" valueName="Alias"/>
+        <text id="SearchEngine_Description" valueName="Description"/>
+        <text id="SearchEngine_SuggestURLTemplate" valueName="SuggestURLTemplate"/>
+      </elements>
+    </policy>
+    <policy name="SearchEngines_3" class="Both" displayName="$(string.SearchEngines_3)" explainText="$(string.SearchEngines_Explain)" key="Software\Policies\Mozilla\Firefox\SearchEngines\Add\3" presentation="$(presentation.SearchEngine)" >
+      <parentCategory ref="Search" />
+      <supportedOn ref="SUPPORTED_WINXPSP2" />
+      <elements >
+        <text id="SearchEngine_Name" valueName="Name" required="true" />
+        <text id="SearchEngine_URLTemplate" valueName="URLTemplate" required="true" />
+        <enum id="SearchEngine_Method" valueName="Method">
+          <item displayName="$(string.SearchEngine_Method_GET)">
+            <value>
+              <string>GET</string>
+            </value>
+          </item>
+          <item displayName="$(string.SearchEngine_Method_POST)">
+            <value>
+              <string>POST</string>
+            </value>
+          </item>
+        </enum>
+        <text id="SearchEngine_IconURL" valueName="IconURL"/>
+        <text id="SearchEngine_Alias" valueName="Alias"/>
+        <text id="SearchEngine_Description" valueName="Description"/>
+        <text id="SearchEngine_SuggestURLTemplate" valueName="SuggestURLTemplate"/>
+      </elements>
+    </policy>
+    <policy name="SearchEngines_4" class="Both" displayName="$(string.SearchEngines_4)" explainText="$(string.SearchEngines_Explain)" key="Software\Policies\Mozilla\Firefox\SearchEngines\Add\4" presentation="$(presentation.SearchEngine)" >
+      <parentCategory ref="Search" />
+      <supportedOn ref="SUPPORTED_WINXPSP2" />
+      <elements >
+        <text id="SearchEngine_Name" valueName="Name" required="true" />
+        <text id="SearchEngine_URLTemplate" valueName="URLTemplate" required="true" />
+        <enum id="SearchEngine_Method" valueName="Method">
+          <item displayName="$(string.SearchEngine_Method_GET)">
+            <value>
+              <string>GET</string>
+            </value>
+          </item>
+          <item displayName="$(string.SearchEngine_Method_POST)">
+            <value>
+              <string>POST</string>
+            </value>
+          </item>
+        </enum>
+        <text id="SearchEngine_IconURL" valueName="IconURL"/>
+        <text id="SearchEngine_Alias" valueName="Alias"/>
+        <text id="SearchEngine_Description" valueName="Description"/>
+        <text id="SearchEngine_SuggestURLTemplate" valueName="SuggestURLTemplate"/>
+      </elements>
+    </policy>
+    <policy name="SearchEngines_5" class="Both" displayName="$(string.SearchEngines_5)" explainText="$(string.SearchEngines_Explain)" key="Software\Policies\Mozilla\Firefox\SearchEngines\Add\5" presentation="$(presentation.SearchEngine)" >
+      <parentCategory ref="Search" />
+      <supportedOn ref="SUPPORTED_WINXPSP2" />
+      <elements >
+        <text id="SearchEngine_Name" valueName="Name" required="true" />
+        <text id="SearchEngine_URLTemplate" valueName="URLTemplate" required="true" />
+        <enum id="SearchEngine_Method" valueName="Method">
+          <item displayName="$(string.SearchEngine_Method_GET)">
+            <value>
+              <string>GET</string>
+            </value>
+          </item>
+          <item displayName="$(string.SearchEngine_Method_POST)">
+            <value>
+              <string>POST</string>
+            </value>
+          </item>
+        </enum>
+        <text id="SearchEngine_IconURL" valueName="IconURL"/>
+        <text id="SearchEngine_Alias" valueName="Alias"/>
+        <text id="SearchEngine_Description" valueName="Description"/>
+        <text id="SearchEngine_SuggestURLTemplate" valueName="SuggestURLTemplate"/>
+      </elements>
+    </policy>
+    <policy name="SearchEngines_Default" class="Both" displayName="$(string.SearchEngines_Default)" explainText="$(string.SearchEngines_Default_Explain)" key="Software\Policies\Mozilla\Firefox\SearchEngines" presentation="$(presentation.SearchEngines_Default)" >
+      <parentCategory ref="Search" />
+      <supportedOn ref="SUPPORTED_WINXPSP2" />
+      <elements >
+        <text id="SearchEngines_Default" valueName="Default" required="true" />
+      </elements>
+    </policy>
+    <policy name="SearchEngines_PreventInstalls" class="Both" displayName="$(string.SearchEngines_PreventInstalls)" explainText="$(string.SearchEngines_PreventInstalls_Explain)" key="Software\Policies\Mozilla\Firefox\SearchEngines" valueName="PreventInstalls">
+      <parentCategory ref="Search" />
+      <supportedOn ref="SUPPORTED_WINXPSP2" />
+      <enabledValue>
+        <decimal value="1"/>
+      </enabledValue>
+      <disabledValue>
+        <decimal value="0"/>
+      </disabledValue>
+    </policy>
   </policies>
 </policyDefinitions>