Firefoxのブックマーク機能を変えた
tags: 情報
大規模ソフトウェアを手探るという授業の一環でやっています
Firefoxのビルドに関して
前回の記事を読んで下さい
現在のブックマーク機能
現在のFirefoxのブックマーク機能では常にデフォルトの保存先フォルダ(Other Bookmarks)に保存することが決まっています
これを,最後にブックマークを保存したフォルダに随時変更するようにしたいと思いました
変更されたブックマーク機能
ということで,ブラウザが開いている間にブックマークしたページの最新の保存先にデフォルトのフォルダが更新されるように変更を加えました
加えて,その機能をToggleできるようにしました
デフォルトの保存先を変更するためのソースコード
結局ソースコードを見るのが一番わかるはずです
デフォルトの保存先フォルダを変更するために修正を加える必要があるのはbrowser/base/content/browser-placesにあるparentGuidです
この変数が保存先フォルダを指しています
最初の実装では別にLAST_USED_PARENT_IDというグローバル変数を作り,これで最後に保存したフォルダを記憶し,これをparentGuidに代入するようにしました
diff --git a/browser/base/content/browser-places.js b/browser/base/content/browser-places.js index 809e6b642f..9e567ad831 100644 --- a/browser/base/content/browser-places.js +++ b/browser/base/content/browser-places.js @@ -5,6 +5,8 @@ // This file is loaded into the browser window scope. /* eslint-env mozilla/browser-window */ +var LAST_USED_PARENT_ID = undefined; XPCOMUtils.defineLazyScriptGetter( this, ["PlacesToolbar", "PlacesMenu", "PlacesPanelview", "PlacesPanelMenuView"], @@ -70,6 +72,7 @@ var StarUI = { clearTimeout(this._autoCloseTimer); if (aEvent.originalTarget == this.panel) { let selectedFolderGuid = gEditItemOverlay.selectedFolderGuid; + LAST_USED_PARENT_ID = selectedFolderGuid; gEditItemOverlay.uninitPanel(true); this._anchorElement.removeAttribute("open"); @@ -444,7 +447,12 @@ var PlacesCommandHook = { let isNewBookmark = !info; let showEditUI = !isNewBookmark || StarUI.showForNewBookmarks; if (isNewBookmark) { - let parentGuid = PlacesUtils.bookmarks.unfiledGuid; + let parentGuid; + if (LAST_USED_PARENT_ID !== undefined) { + parentGuid = LAST_USED_PARENT_ID; + } else { + parentGuid = PlacesUtils.bookmarks.unfiledGuid; + } info = { url, parentGuid }; // Bug 1148838 - Make this code work for full page plugins. let charset = null;
しかし,これは安全なコードではないのでグローバル変数をなくすために以下のように書き直しました
diff --git a/browser/base/content/browser-places.js b/browser/base/content/browser-places.js index 809e6b642f..994d573568 100644 --- a/browser/base/content/browser-places.js +++ b/browser/base/content/browser-places.js @@ -28,6 +28,7 @@ var StarUI = { // in browser/components/pocket/content/panels/js/saved.js. _autoCloseTimeout: 3500, _removeBookmarksOnPopupHidden: false, + _lastUsedParentId : undefined, _element(aID) { return document.getElementById(aID); @@ -70,6 +71,7 @@ var StarUI = { clearTimeout(this._autoCloseTimer); if (aEvent.originalTarget == this.panel) { let selectedFolderGuid = gEditItemOverlay.selectedFolderGuid; + this._lastUsedParentId = selectedFolderGuid; gEditItemOverlay.uninitPanel(true); this._anchorElement.removeAttribute("open"); @@ -443,8 +445,14 @@ var PlacesCommandHook = { let info = await PlacesUtils.bookmarks.fetch({ url }); let isNewBookmark = !info; let showEditUI = !isNewBookmark || StarUI.showForNewBookmarks; + let lastUsedParentId = StarUI._lastUsedParentId; if (isNewBookmark) { - let parentGuid = PlacesUtils.bookmarks.unfiledGuid; + let parentGuid; + if (lastUsedParentId !== undefined) { + parentGuid = lastUsedParentId; + } else { + parentGuid = PlacesUtils.bookmarks.unfiledGuid; + } info = { url, parentGuid }; // Bug 1148838 - Make this code work for full page plugins. let charset = null;
ついでにJSのお作法を知らなかったのでそこも直しました
Javascriptでのnullは何もない値とこちらから決めた値です.しかし上ではundefinedが使われています
つまりundefinedは意図的に定める値ではないのにここでは定められています.それをnullに変更
diff --git a/browser/base/content/browser-places.js b/browser/base/content/browser-places.js index 994d573568..ae8041e65e 100644 --- a/browser/base/content/browser-places.js +++ b/browser/base/content/browser-places.js @@ -28,7 +28,7 @@ var StarUI = { // in browser/components/pocket/content/panels/js/saved.js. _autoCloseTimeout: 3500, _removeBookmarksOnPopupHidden: false, - _lastUsedParentId : undefined, + _lastUsedParentId: null, _element(aID) { return document.getElementById(aID); @@ -448,7 +448,7 @@ var PlacesCommandHook = { let lastUsedParentId = StarUI._lastUsedParentId; if (isNewBookmark) { let parentGuid; - if (lastUsedParentId !== undefined) { + if (lastUsedParentId !== null) { parentGuid = lastUsedParentId; } else { parentGuid = PlacesUtils.bookmarks.unfiledGuid; diff --git a/done.txt b/done.txt new file mode 100644 index 0000000000..cfa2b8818c --- /dev/null +++ b/done.txt @@ -0,0 +1,38 @@
これで完成です.本当に少ししかいじっていないし,僕は大規模ソフトウェアの表面をなぞっているだけだ...と若干鬱です
Toggleするためのソースコード
上の機能を使用したくない人もいると思います.ということで切り替えができるようにしました
既存のFirefoxにはブックマークをした時に,ブックマーク先をどうするか選ぶためのエディタ(下の画像の通り)が開くかどうかをToggleできます.これをパクって利用してやろうということになりました
"Show editor when saving"がデフォルトの部分
"Use default folder"が今回追加した部分
実際にコードを変更したのは次の4箇所です
firefox.js
ここではtoggleするために必要な変数を設定しています.デフォルトだとtrueにしてあります(つまり,最後の保存先フォルダを記憶しない設定にしてあります)
diff --git a/browser/app/profile/firefox.js b/browser/app/profile/firefox.js index 2bbfc67da2..7606fad678 100644 --- a/browser/app/profile/firefox.js +++ b/browser/app/profile/firefox.js @@ -1009,6 +1009,9 @@ pref("browser.privatebrowsing.autostart", false); // Whether the bookmark panel should be shown when bookmarking a page. pref("browser.bookmarks.editDialog.showForNewBookmarks", true); +// Whether the default bookmark foulder should be shown when bookmarking a page +pref("browser.bookmarks.editDialog.toggleDefaultFolder", true); + // Don't try to alter this pref, it'll be reset the next time you use the // bookmarking dialog pref("browser.bookmarks.editDialog.firstEditField", "namePicker");
browser-places.js
ここでは実際にブラウザ上でブックマークをした際にtoggleに必要な変数が変更がされるようにしています
何が起こっているのかはおそらく多少プログラミングをしたことがある人にはわかるでしょ.ただ,わからないという人もいると思うので説明しておきます
下から説明します
if構文から説明します.ここではtoggleボタンで最後の保存先をフォルダを使うかどうか決めています- 次の
onToggleDefaultFolderCheckboxではチェックボックスがチェックされているかに応じてブックマークの設定を決める値にブール値を設定しています - 次の
this._elementの部分ではjavascriptの文法がよくわからないのですが,thisの中にthis.toggleDefaultFolderの値を代入しています getの部分はthis.toggleDefaultFolderで呼び出された際にbrowser.bookmarks.editDialog.toggleDefaultFolderのブール値を返します
この部分はブックマークエディタでチェックを入れたり,消した際に呼び出される関数郡が書かれています
diff --git a/browser/base/content/browser-places.js b/browser/base/content/browser-places.js index ae8041e65e..aa8bc2f7b0 100644 --- a/browser/base/content/browser-places.js +++ b/browser/base/content/browser-places.js @@ -40,6 +40,12 @@ var StarUI = { ); }, + get toggleDefaultFolder() { + return Services.prefs.getBoolPref( + "browser.bookmarks.editDialog.toggleDefaultFolder" + ) + }, + // Edit-bookmark panel get panel() { delete this.panel; @@ -221,6 +227,10 @@ var StarUI = { "editBookmarkPanel_showForNewBookmarks" ).checked = this.showForNewBookmarks; + this._element( + "editBookmarkPanel_toggleDefaultFolder" + ).checked = this.toggleDefaultFolder; + this._itemGuids = []; await PlacesUtils.bookmarks.fetch({ url: aUrl }, bookmark => this._itemGuids.push(bookmark.guid) @@ -400,6 +410,13 @@ var StarUI = { ); }, + onToggleDefaultFolderCheckboxCommand() { + Services.prefs.setBoolPref( + "browser.bookmarks.editDialog.toggleDefaultFolder", + this._element("editBookmarkPanel_toggleDefaultFolder").checked + ); + }, + showConfirmation() { let animationTriggered = LibraryUI.triggerLibraryAnimation("bookmark"); @@ -448,10 +465,10 @@ var PlacesCommandHook = { let lastUsedParentId = StarUI._lastUsedParentId; if (isNewBookmark) { let parentGuid; - if (lastUsedParentId !== null) { - parentGuid = lastUsedParentId; - } else { + if (StarUI.toggleDefaultFolder || lastUsedParentId === null) { parentGuid = PlacesUtils.bookmarks.unfiledGuid; + } else { + parentGuid = lastUsedParentId; } info = { url, parentGuid }; // Bug 1148838 - Make this code work for full page plugins.
browser.xhtml
ここではブックマークエディタの表示を決めています.checkboxという部分からチェックボックスを作っていることがわかると思います
特に重要なのはoncommandという部分で,ここでチェックされた際に呼び出される関数を決めています
diff --git a/browser/base/content/browser.xhtml b/browser/base/content/browser.xhtml index e53c9f7f4b..69daa32920 100644 --- a/browser/base/content/browser.xhtml +++ b/browser/base/content/browser.xhtml @@ -290,6 +290,13 @@ accesskey="&editBookmark.showForNewBookmarks.accesskey;" oncommand="StarUI.onShowForNewBookmarksCheckboxCommand();"/> </vbox> + <vbox id="editBookmarkPanelBottomContent" + flex="1"> + <checkbox id="editBookmarkPanel_toggleDefaultFolder" + label="&editBookmark.toggleDefaultFolder.label;" + accesskey="&editBookmark.toggleDefaultFolder.accesskey;" + oncommand="StarUI.onToggleDefaultFolderCheckboxCommand();"/> + </vbox> <hbox id="editBookmarkPanelBottomButtons" class="panel-footer" style="min-width: &editBookmark.panel.width;;">
browser.dtd
ここはブックマークエディタで表示される文言を設定しています.上で定めたlabelやaccesskeyと対応しているとわかると思います
チェックボックスにチェックを加えるとデフォルトのフォルダを使うようにしているので"Use default folder"という文言にしています
diff --git a/browser/locales/en-US/chrome/browser/browser.dtd b/browser/locales/en-US/chrome/browser/browser.dtd index 0407ec8a0b..1cac2da49b 100644 --- a/browser/locales/en-US/chrome/browser/browser.dtd +++ b/browser/locales/en-US/chrome/browser/browser.dtd @@ -627,6 +627,8 @@ you can use these alternative items. Otherwise, their values should be empty. - <!ENTITY editBookmark.done.label "Done"> <!ENTITY editBookmark.showForNewBookmarks.label "Show editor when saving"> <!ENTITY editBookmark.showForNewBookmarks.accesskey "S"> +<!ENTITY editBookmark.toggleDefaultFolder.label "Use default folder"> +<!ENTITY editBookmark.toggleDefaultFolder.accesskey "S"> <!ENTITY identity.connectionSecure3 "Connection secure"> <!ENTITY identity.connectionNotSecure2 "Connection not secure">
開発に関して
Searchfox, Bugzillaというツールが有効でした
SearchfoxはFirefox用のGoogle検索みたいなもので,変数名などを検索したら色々と出てきます
BugzillaはMozilla(Firefoxを開発しているところ)のIssueが転がっている場所です.関連したIssueを見て勉強に成りました(ソースコードが変わっていてあまり使えなかった)
より使えたのはDeveloper toolsです
このページがわかりやすいです
これらを見ながら機能を推測して,変えて,その結果を眺めるというのを繰り返して開発をしていました
スライド
授業の一環でやったのでスライドにしてあります.以下の通りです
気になったらご覧ください
感想
前回のインターン
大規模ソフトウェアをいじった経験はインターン以来でした(夏にWeb系の企業にインターンに行った)
この時はRuby on Railsをいじっていました
で,そのときに感じたのは,大規模ソフトウェアの開発って変えたい機能に関連する部分をちょこちょこ変えるだけでつまらなくないですか???ということです
そこではタスクが振られて,それをこなすという風に開発をしていたのですが,毎回異なる機能について実装をしていたので新しいことをやれるという反面,毎回同じことを覚える必要があり,｢あまりおもしろくない...｣と思っていました
今回の実験
しかし,今回はもう少し長い時間同じソフトウェアを触れていたのでまた違った感想を持ちました
開発に関する速度はそのソフトウェアに関する知識を真数とした対数グラフみたいになっていて,だんだん知識が深まると開発も早くなり楽しくなるよねということです
大規模ソフトウェアと言っても挙動を理解するだけならある程度読めばなんとか理解できます
ということで｢大規模ソフトウェアも楽しいよ｣というのが今回の感想
それと早く｢慣れる｣速度を高めたいなということです.慣れるのが早ければ早くなるほど多分もっとソフトウェアの開発も楽しめるはずです
最後に
相方と先生,TAの方に感謝
大規模ソフトウェアをいじるといっても大したことはないと思えるように成りました
眺めているだけでも楽しいのでコミットまでできるように頑張りたい
