selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
1 lines • 16.1 kB
HTML
<meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>extension.js</title><link href="../../dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article class="srcfile"><h1>firefox/extension.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Licensed to the Software Freedom Conservancy (SFC) under one<tr><td><a id="l2"></a><a href="#l2">2</a><td>// or more contributor license agreements. See the NOTICE file<tr><td><a id="l3"></a><a href="#l3">3</a><td>// distributed with this work for additional information<tr><td><a id="l4"></a><a href="#l4">4</a><td>// regarding copyright ownership. The SFC licenses this file<tr><td><a id="l5"></a><a href="#l5">5</a><td>// to you under the Apache License, Version 2.0 (the<tr><td><a id="l6"></a><a href="#l6">6</a><td>// "License"); you may not use this file except in compliance<tr><td><a id="l7"></a><a href="#l7">7</a><td>// with the License. You may obtain a copy of the License at<tr><td><a id="l8"></a><a href="#l8">8</a><td>//<tr><td><a id="l9"></a><a href="#l9">9</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a id="l10"></a><a href="#l10">10</a><td>//<tr><td><a id="l11"></a><a href="#l11">11</a><td>// Unless required by applicable law or agreed to in writing,<tr><td><a id="l12"></a><a href="#l12">12</a><td>// software distributed under the License is distributed on an<tr><td><a id="l13"></a><a href="#l13">13</a><td>// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<tr><td><a id="l14"></a><a href="#l14">14</a><td>// KIND, either express or implied. See the License for the<tr><td><a id="l15"></a><a href="#l15">15</a><td>// specific language governing permissions and limitations<tr><td><a id="l16"></a><a href="#l16">16</a><td>// under the License.<tr><td><a id="l17"></a><a href="#l17">17</a><td><tr><td><a id="l18"></a><a href="#l18">18</a><td>/** @fileoverview Utilities for working with Firefox extensions. */<tr><td><a id="l19"></a><a href="#l19">19</a><td><tr><td><a id="l20"></a><a href="#l20">20</a><td>'use strict';<tr><td><a id="l21"></a><a href="#l21">21</a><td><tr><td><a id="l22"></a><a href="#l22">22</a><td>var AdmZip = require('adm-zip'),<tr><td><a id="l23"></a><a href="#l23">23</a><td> fs = require('fs'),<tr><td><a id="l24"></a><a href="#l24">24</a><td> path = require('path'),<tr><td><a id="l25"></a><a href="#l25">25</a><td> util = require('util'),<tr><td><a id="l26"></a><a href="#l26">26</a><td> xml = require('xml2js');<tr><td><a id="l27"></a><a href="#l27">27</a><td><tr><td><a id="l28"></a><a href="#l28">28</a><td>var promise = require('..').promise,<tr><td><a id="l29"></a><a href="#l29">29</a><td> checkedCall = promise.checkedNodeCall,<tr><td><a id="l30"></a><a href="#l30">30</a><td> io = require('../io');<tr><td><a id="l31"></a><a href="#l31">31</a><td><tr><td><a id="l32"></a><a href="#l32">32</a><td><tr><td><a id="l33"></a><a href="#l33">33</a><td>/**<tr><td><a id="l34"></a><a href="#l34">34</a><td> * Thrown when there an add-on is malformed.<tr><td><a id="l35"></a><a href="#l35">35</a><td> * @param {string} msg The error message.<tr><td><a id="l36"></a><a href="#l36">36</a><td> * @constructor<tr><td><a id="l37"></a><a href="#l37">37</a><td> * @extends {Error}<tr><td><a id="l38"></a><a href="#l38">38</a><td> */<tr><td><a id="l39"></a><a href="#l39">39</a><td>function AddonFormatError(msg) {<tr><td><a id="l40"></a><a href="#l40">40</a><td> Error.call(this);<tr><td><a id="l41"></a><a href="#l41">41</a><td><tr><td><a id="l42"></a><a href="#l42">42</a><td> Error.captureStackTrace(this, AddonFormatError);<tr><td><a id="l43"></a><a href="#l43">43</a><td><tr><td><a id="l44"></a><a href="#l44">44</a><td> /** @override */<tr><td><a id="l45"></a><a href="#l45">45</a><td> this.name = AddonFormatError.name;<tr><td><a id="l46"></a><a href="#l46">46</a><td><tr><td><a id="l47"></a><a href="#l47">47</a><td> /** @override */<tr><td><a id="l48"></a><a href="#l48">48</a><td> this.message = msg;<tr><td><a id="l49"></a><a href="#l49">49</a><td>}<tr><td><a id="l50"></a><a href="#l50">50</a><td>util.inherits(AddonFormatError, Error);<tr><td><a id="l51"></a><a href="#l51">51</a><td><tr><td><a id="l52"></a><a href="#l52">52</a><td><tr><td><a id="l53"></a><a href="#l53">53</a><td><tr><td><a id="l54"></a><a href="#l54">54</a><td>/**<tr><td><a id="l55"></a><a href="#l55">55</a><td> * Installs an extension to the given directory.<tr><td><a id="l56"></a><a href="#l56">56</a><td> * @param {string} extension Path to the extension to install, as either a xpi<tr><td><a id="l57"></a><a href="#l57">57</a><td> * file or a directory.<tr><td><a id="l58"></a><a href="#l58">58</a><td> * @param {string} dir Path to the directory to install the extension in.<tr><td><a id="l59"></a><a href="#l59">59</a><td> * @return {!promise.Promise.<string>} A promise for the add-on ID once<tr><td><a id="l60"></a><a href="#l60">60</a><td> * installed.<tr><td><a id="l61"></a><a href="#l61">61</a><td> */<tr><td><a id="l62"></a><a href="#l62">62</a><td>function install(extension, dir) {<tr><td><a id="l63"></a><a href="#l63">63</a><td> return getDetails(extension).then(function(details) {<tr><td><a id="l64"></a><a href="#l64">64</a><td> function returnId() { return details.id; }<tr><td><a id="l65"></a><a href="#l65">65</a><td><tr><td><a id="l66"></a><a href="#l66">66</a><td> var dst = path.join(dir, details.id);<tr><td><a id="l67"></a><a href="#l67">67</a><td> if (extension.slice(-4) === '.xpi') {<tr><td><a id="l68"></a><a href="#l68">68</a><td> if (!details.unpack) {<tr><td><a id="l69"></a><a href="#l69">69</a><td> return io.copy(extension, dst + '.xpi').then(returnId);<tr><td><a id="l70"></a><a href="#l70">70</a><td> } else {<tr><td><a id="l71"></a><a href="#l71">71</a><td> return checkedCall(fs.readFile, extension).then(function(buff) {<tr><td><a id="l72"></a><a href="#l72">72</a><td> var zip = new AdmZip(buff);<tr><td><a id="l73"></a><a href="#l73">73</a><td> // TODO: find an async library for inflating a zip archive.<tr><td><a id="l74"></a><a href="#l74">74</a><td> new AdmZip(buff).extractAllTo(dst, true);<tr><td><a id="l75"></a><a href="#l75">75</a><td> }).then(returnId);<tr><td><a id="l76"></a><a href="#l76">76</a><td> }<tr><td><a id="l77"></a><a href="#l77">77</a><td> } else {<tr><td><a id="l78"></a><a href="#l78">78</a><td> return io.copyDir(extension, dst).then(returnId);<tr><td><a id="l79"></a><a href="#l79">79</a><td> }<tr><td><a id="l80"></a><a href="#l80">80</a><td> });<tr><td><a id="l81"></a><a href="#l81">81</a><td>}<tr><td><a id="l82"></a><a href="#l82">82</a><td><tr><td><a id="l83"></a><a href="#l83">83</a><td><tr><td><a id="l84"></a><a href="#l84">84</a><td>/**<tr><td><a id="l85"></a><a href="#l85">85</a><td> * Describes a Firefox add-on.<tr><td><a id="l86"></a><a href="#l86">86</a><td> * @typedef {{id: string, name: string, version: string, unpack: boolean}}<tr><td><a id="l87"></a><a href="#l87">87</a><td> */<tr><td><a id="l88"></a><a href="#l88">88</a><td>var AddonDetails;<tr><td><a id="l89"></a><a href="#l89">89</a><td><tr><td><a id="l90"></a><a href="#l90">90</a><td><tr><td><a id="l91"></a><a href="#l91">91</a><td>/**<tr><td><a id="l92"></a><a href="#l92">92</a><td> * Extracts the details needed to install an add-on.<tr><td><a id="l93"></a><a href="#l93">93</a><td> * @param {string} addonPath Path to the extension directory.<tr><td><a id="l94"></a><a href="#l94">94</a><td> * @return {!promise.Promise.<!AddonDetails>} A promise for the add-on details.<tr><td><a id="l95"></a><a href="#l95">95</a><td> */<tr><td><a id="l96"></a><a href="#l96">96</a><td>function getDetails(addonPath) {<tr><td><a id="l97"></a><a href="#l97">97</a><td> return readManifest(addonPath).then(function(doc) {<tr><td><a id="l98"></a><a href="#l98">98</a><td> var em = getNamespaceId(doc, 'http://www.mozilla.org/2004/em-rdf#');<tr><td><a id="l99"></a><a href="#l99">99</a><td> var rdf = getNamespaceId(<tr><td><a id="l100"></a><a href="#l100">100</a><td> doc, 'http://www.w3.org/1999/02/22-rdf-syntax-ns#');<tr><td><a id="l101"></a><a href="#l101">101</a><td><tr><td><a id="l102"></a><a href="#l102">102</a><td> var description = doc[rdf + 'RDF'][rdf + 'Description'][0];<tr><td><a id="l103"></a><a href="#l103">103</a><td> var details = {<tr><td><a id="l104"></a><a href="#l104">104</a><td> id: getNodeText(description, em + 'id'),<tr><td><a id="l105"></a><a href="#l105">105</a><td> name: getNodeText(description, em + 'name'),<tr><td><a id="l106"></a><a href="#l106">106</a><td> version: getNodeText(description, em + 'version'),<tr><td><a id="l107"></a><a href="#l107">107</a><td> unpack: getNodeText(description, em + 'unpack') || false<tr><td><a id="l108"></a><a href="#l108">108</a><td> };<tr><td><a id="l109"></a><a href="#l109">109</a><td><tr><td><a id="l110"></a><a href="#l110">110</a><td> if (typeof details.unpack === 'string') {<tr><td><a id="l111"></a><a href="#l111">111</a><td> details.unpack = details.unpack.toLowerCase() === 'true';<tr><td><a id="l112"></a><a href="#l112">112</a><td> }<tr><td><a id="l113"></a><a href="#l113">113</a><td><tr><td><a id="l114"></a><a href="#l114">114</a><td> if (!details.id) {<tr><td><a id="l115"></a><a href="#l115">115</a><td> throw new AddonFormatError('Could not find add-on ID for ' + addonPath);<tr><td><a id="l116"></a><a href="#l116">116</a><td> }<tr><td><a id="l117"></a><a href="#l117">117</a><td><tr><td><a id="l118"></a><a href="#l118">118</a><td> return details;<tr><td><a id="l119"></a><a href="#l119">119</a><td> });<tr><td><a id="l120"></a><a href="#l120">120</a><td><tr><td><a id="l121"></a><a href="#l121">121</a><td> function getNodeText(node, name) {<tr><td><a id="l122"></a><a href="#l122">122</a><td> return node[name] && node[name][0] || '';<tr><td><a id="l123"></a><a href="#l123">123</a><td> }<tr><td><a id="l124"></a><a href="#l124">124</a><td><tr><td><a id="l125"></a><a href="#l125">125</a><td> function getNamespaceId(doc, url) {<tr><td><a id="l126"></a><a href="#l126">126</a><td> var keys = Object.keys(doc);<tr><td><a id="l127"></a><a href="#l127">127</a><td> if (keys.length !== 1) {<tr><td><a id="l128"></a><a href="#l128">128</a><td> throw new AddonFormatError('Malformed manifest for add-on ' + addonPath);<tr><td><a id="l129"></a><a href="#l129">129</a><td> }<tr><td><a id="l130"></a><a href="#l130">130</a><td><tr><td><a id="l131"></a><a href="#l131">131</a><td> var namespaces = doc[keys[0]].$;<tr><td><a id="l132"></a><a href="#l132">132</a><td> var id = '';<tr><td><a id="l133"></a><a href="#l133">133</a><td> Object.keys(namespaces).some(function(ns) {<tr><td><a id="l134"></a><a href="#l134">134</a><td> if (namespaces[ns] !== url) {<tr><td><a id="l135"></a><a href="#l135">135</a><td> return false;<tr><td><a id="l136"></a><a href="#l136">136</a><td> }<tr><td><a id="l137"></a><a href="#l137">137</a><td><tr><td><a id="l138"></a><a href="#l138">138</a><td> if (ns.indexOf(':') != -1) {<tr><td><a id="l139"></a><a href="#l139">139</a><td> id = ns.split(':')[1] + ':';<tr><td><a id="l140"></a><a href="#l140">140</a><td> }<tr><td><a id="l141"></a><a href="#l141">141</a><td> return true;<tr><td><a id="l142"></a><a href="#l142">142</a><td> });<tr><td><a id="l143"></a><a href="#l143">143</a><td> return id;<tr><td><a id="l144"></a><a href="#l144">144</a><td> }<tr><td><a id="l145"></a><a href="#l145">145</a><td>}<tr><td><a id="l146"></a><a href="#l146">146</a><td><tr><td><a id="l147"></a><a href="#l147">147</a><td><tr><td><a id="l148"></a><a href="#l148">148</a><td>/**<tr><td><a id="l149"></a><a href="#l149">149</a><td> * Reads the manifest for a Firefox add-on.<tr><td><a id="l150"></a><a href="#l150">150</a><td> * @param {string} addonPath Path to a Firefox add-on as a xpi or an extension.<tr><td><a id="l151"></a><a href="#l151">151</a><td> * @return {!promise.Promise.<!Object>} A promise for the parsed manifest.<tr><td><a id="l152"></a><a href="#l152">152</a><td> */<tr><td><a id="l153"></a><a href="#l153">153</a><td>function readManifest(addonPath) {<tr><td><a id="l154"></a><a href="#l154">154</a><td> var manifest;<tr><td><a id="l155"></a><a href="#l155">155</a><td><tr><td><a id="l156"></a><a href="#l156">156</a><td> if (addonPath.slice(-4) === '.xpi') {<tr><td><a id="l157"></a><a href="#l157">157</a><td> manifest = checkedCall(fs.readFile, addonPath).then(function(buff) {<tr><td><a id="l158"></a><a href="#l158">158</a><td> var zip = new AdmZip(buff);<tr><td><a id="l159"></a><a href="#l159">159</a><td> if (!zip.getEntry('install.rdf')) {<tr><td><a id="l160"></a><a href="#l160">160</a><td> throw new AddonFormatError(<tr><td><a id="l161"></a><a href="#l161">161</a><td> 'Could not find install.rdf in ' + addonPath);<tr><td><a id="l162"></a><a href="#l162">162</a><td> }<tr><td><a id="l163"></a><a href="#l163">163</a><td> var done = promise.defer();<tr><td><a id="l164"></a><a href="#l164">164</a><td> zip.readAsTextAsync('install.rdf', done.fulfill);<tr><td><a id="l165"></a><a href="#l165">165</a><td> return done.promise;<tr><td><a id="l166"></a><a href="#l166">166</a><td> });<tr><td><a id="l167"></a><a href="#l167">167</a><td> } else {<tr><td><a id="l168"></a><a href="#l168">168</a><td> manifest = checkedCall(fs.stat, addonPath).then(function(stats) {<tr><td><a id="l169"></a><a href="#l169">169</a><td> if (!stats.isDirectory()) {<tr><td><a id="l170"></a><a href="#l170">170</a><td> throw Error(<tr><td><a id="l171"></a><a href="#l171">171</a><td> 'Add-on path is niether a xpi nor a directory: ' + addonPath);<tr><td><a id="l172"></a><a href="#l172">172</a><td> }<tr><td><a id="l173"></a><a href="#l173">173</a><td> return checkedCall(fs.readFile, path.join(addonPath, 'install.rdf'));<tr><td><a id="l174"></a><a href="#l174">174</a><td> });<tr><td><a id="l175"></a><a href="#l175">175</a><td> }<tr><td><a id="l176"></a><a href="#l176">176</a><td><tr><td><a id="l177"></a><a href="#l177">177</a><td> return manifest.then(function(content) {<tr><td><a id="l178"></a><a href="#l178">178</a><td> return checkedCall(xml.parseString, content);<tr><td><a id="l179"></a><a href="#l179">179</a><td> });<tr><td><a id="l180"></a><a href="#l180">180</a><td>}<tr><td><a id="l181"></a><a href="#l181">181</a><td><tr><td><a id="l182"></a><a href="#l182">182</a><td><tr><td><a id="l183"></a><a href="#l183">183</a><td>// PUBLIC API<tr><td><a id="l184"></a><a href="#l184">184</a><td><tr><td><a id="l185"></a><a href="#l185">185</a><td><tr><td><a id="l186"></a><a href="#l186">186</a><td>exports.install = install;</table></div></article><nav><h3><a href="../../index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="../../Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="../../types.js"></script><script src="../../dossier.js"></script>