गनोम शेल के लिए एक्सटेंशन कैसे लिखें: डिस्टर्ब मोड नहीं

यह सब एक लिनक्स वितरण के एक नए संस्करण में जाने के साथ शुरू हुआ, और वहाँ - कुख्यात GNOME शेल (संक्षेप में जीएच), जावास्क्रिप्ट में। ठीक है, ठीक है, जेएस पर इतना जेएस पर, यह काम करता है - और ठीक है।

उसी समय, मेरे काम की गति ने लंबे समय से ब्राउजर में outlook.office.com टैब के मेगाबाइट के ब्रेकिंग और गुज़लिंग टन के बजाय एक सामान्य मेलर खोजने की मांग की है। और अब मैंने पाया, हमारे समय में लगभग कई उत्कृष्ट उम्मीदवार हैं, एक परेशानी - मेलर ने मुझे नए अक्षरों की सूचनाओं के साथ मिलना शुरू किया - और ध्वनि, और पॉप-अप शिलालेख।

क्या करें? डू नॉट डिस्टर्ब एक्सटेंशन लिखने का निर्णय तुरंत नहीं आया, मैं वास्तव में बाइक लिखना और / या त्रुटियों के विकास / कोड / टन में फंसना नहीं चाहता था, लेकिन मैंने फैसला किया, और अब मैं अपना अनुभव हैबर के साथ साझा करना चाहता हूं। ¹

तकनीकी आवश्यकताओं

मेरे पास है एक बड़ा अपनी पसंद के समय के लिए सूचनाओं और ध्वनियों को बंद करने के लिए बटन: 20 मिनट, 40 मिनट, 1 घंटा, 2 घंटे, 4, 8 और 24 घंटे। ² हाँ, समय सुस्त की तरह।

एक्सटेंशन.gnome.org के विस्तार पर "डू नॉट डिस्टर्ब बटन" का एक एक्सटेंशन था, जिसने अपने एक्सटेंशन डू नॉट डिस्टर्ब टाइम को लिखने के लिए एक मॉडल के रूप में कार्य किया।

अंतिम परिणाम: समय को डिस्टर्ब न करें

Extension.gnome.org से इंस्टॉल करें।
गीथुब पर स्रोत: सितारों, कांटा, सुधार की पेशकश करें।

जीएच एक्सटेंशन कैसे स्थापित करें: निर्देश

1. उदाहरण के रूप में उबंटू का उपयोग करके क्रोम-गनोम-शेल पैकेज, एक ब्राउज़र कनेक्टर स्थापित करें:
   sudo apt install chrome-gnome-shell
2. लिंक का उपयोग करके , ब्राउज़र एक्सटेंशन इंस्टॉल करें:
   
   • लिंक का पालन करें ब्राउज़र एक्सटेंशन स्थापित करने के लिए यहां क्लिक करें
   • उबंटू 18.04 में, इसने मेरे लिए क्रोम / क्रोमियम ब्राउज़र में काम किया, फेडोरा में 28/29 - फ़ायरफ़ॉक्स और क्रोमियम में दोनों
3. हम सूची में वांछित एक्सटेंशन की खोज कर रहे हैं https://extensions.gnome.org : सक्षम करें, अक्षम करें, एक्सटेंशन सेटिंग्स बदलें।
4. लाभ!

शुरुआत

खरोंच से विस्तार बनाएँ:

 $ gnome-shell-extension-tool --create-extension Name: Do Not Disturb Time Description: Disables notifications and sound for a period Uuid: dnd@catbo.net Created extension in '~/.local/share/gnome-shell/extensions/dnd@catbo.net' #  gnome-shell Alt+F2, r, Enter #    https://extensions.gnome.org/local/      #   Gnome Shell - , gnome-shell   systemd,   journalctl -f /usr/bin/gnome-shell #    ,       gnome-shell journalctl -f /usr/bin/gnome-shell | grep -E 'dnd|$' 

इसी निर्देशिका में extension.js फ़ाइल हमारे आवेदन में प्रवेश बिंदु है, न्यूनतम संस्करण में यह इस तरह दिखता है:

 function enable() {} //   ;    function disable() {} // --||-- ;     enable() 

पहला कोड

सबसे पहले, हम ऊपरी दाईं ओर Status Menu एक बटन जोड़ना चाहते हैं, जैसा कि ऊपर दिए गए स्क्रीनशॉट में है।

तो कहाँ से शुरू करें? ओह, दस्तावेज के साथ शुरू करते हैं। हमारे पास आधिकारिक दस्तावेज, सभी चीजें हैं। लेकिन नहीं, आधिकारिक दस्तावेज बहुत छोटा और खंडित है, लेकिन julio641742 और इसके अनौपचारिक दस्तावेज के लिए धन्यवाद, हमें वह मिलता है जिसकी हमें आवश्यकता है:

  // 1 -    (1 - , 0 - , 0.5 -  ) // true,     let dndButton = new PanelMenu.Button(1, "DoNotDisturb", false); // `right` -      (left/center/right) Main.panel.addToStatusArea("DoNotDisturbRole", dndButton, 0, "right"); let box = new St.BoxLayout(); dndButton.actor.add_child(box); let icon = new St.Icon({ style_class: "system-status-icon" }); icon.set_gicon(Gio.icon_new_for_string("/tmp/bell_normal.svg")); box.add(icon); 

यह कोड dndButton वर्ग की dndButton कुंजी ऑब्जेक्ट बनाता है - यह विशेष रूप से स्टेटस मेनू पैनल के लिए डिज़ाइन किया गया बटन है। और हम इसे Main.panel.addToStatusArea () फ़ंक्शन का उपयोग करके इस पैनल में सम्मिलित करते हैं। ³

हैंडलर के साथ मेनू आइटम सम्मिलित करें, उन्हें उदाहरण के लिए:

  let menuItem = new PopupMenu.PopupMenuItem("hello, world!"); menuItem.connect("activate", (menuItem, event) => { log("hello, world!"); }); dndButton.menu.addMenuItem(menuItem); 

प्रलेखन के लिए धन्यवाद, julio641742! लिंक:
https://github.com/julio641742/gnome-shell-extension-reference

अंतिम कार्य कोड यहाँ है ।

GNOME शेल और जावास्क्रिप्ट फीचर्स

बाहर 2018 का अंत है, और जावास्क्रिप्ट कोड चलाने के लिए Node.js / V8 मुख्य उपकरण है। सभी आधुनिक वेब विकास "नोड" पर टिकी हुई है।

लेकिन गनोम शेल और इसके आस-पास के पूरे बुनियादी ढांचे में एक अलग जावास्क्रिप्ट इंजन, मोज़िला का स्पाइडरमोंकी का उपयोग किया जाता है, और यह प्रदर्शन में बहुत महत्वपूर्ण अंतर लाता है।

आयात मॉड्यूल

Node.js के विपरीत, यहां कोई आवश्यकता नहीं है (), और कोई फैंसी ES6- आयात भी नहीं है। इसके बजाय, एक विशेष आयात वस्तु है, जिसके गुणों को एक्सेस करना मॉड्यूल को लोड करने की ओर जाता है:

  //const PanelMenu = require("ui/panelMenu"); const PanelMenu = imports.ui.panelMenu; 

इस स्थिति में, हमने GNOME शेल पैकेज लाइब्रेरी से js / ui / panelMenu.js मॉड्यूल डाउनलोड किया, जो एक पॉप-अप मेनू के साथ एक बटन की कार्यक्षमता को लागू करता है।

हां, गनोम का उपयोग कर एक आधुनिक लिनक्स डेस्कटॉप के पैनल के सभी बटन पैनलमैनों.जेएस पर आधारित हैं। सहित: बैटरी संकेतक, वाई-फाई, ध्वनि की मात्रा के साथ एक ही सही बटन; इनपुट भाषा स्विच एन-आरयू।

अगला, एक विशेष विशेषता imports.searchPath - यह उन रास्तों (पंक्तियों) की एक सूची है जहाँ हमारे JS मॉड्यूल को खोजा जाएगा। उदाहरण के लिए, हमने एक टाइमर फ़ंक्शन को एक अलग टाइम यूटिल्स.जेएस मॉड्यूल के लिए आवंटित किया और इसे हमारे एक्सटेंशन, एक्सटेंशन.जेएस के इनपुट बिंदु के पास रखा। समय के अनुसार आयात करें।

 //     , -  ~/.local/share/gnome-shell/extensions/<your-extension>/ const Me = imports.misc.extensionUtils.getCurrentExtension(); //       imports.searchPath.unshift(Me.path); //   const timeUtils = imports.timeUtils; 

लॉगिंग, डिबगिंग जावास्क्रिप्ट

खैर, चूंकि हमारे पास Node.js नहीं है, तो हमारे पास अपनी लॉगिंग है। कंसोल.लॉग () के बजाय, कोड में कई लॉगिंग फ़ंक्शन उपलब्ध हैं, देखें gjs /../ global.cpp, static_funcs:

• "लॉग" = g_message ("JS LOG:" + संदेश) - Stderr में लॉगिंग, उदाहरण:

 $ cat helloWorld.js log("hello, world"); $ gjs helloWorld.js Gjs-Message: 17:20:21.048: JS LOG: hello, world 

• "logError" - अपवाद स्टैक लॉग करता है:
  
  • पहला आवश्यक तर्क एक अपवाद है, फिर एक अल्पविराम अलग हो जाता है जो आप चाहते हैं
  • उदाहरण के लिए, यदि आपको स्टैक को सही स्थान पर प्रिंट करने की आवश्यकता है:

 try { throw new Error('bum!'); } catch(e) { logError(e, "what a fuck"); } 

और यह स्टाइलर में आकर्षित करेगा:

 (gjs:28674): Gjs-WARNING **: 13:39:46.951: JS ERROR: what a fuck: Error: bum! ggg@./gtk.js:5:15 ddd@./gtk.js:12:5 @./gtk.js:15:1 

• "प्रिंट" = g_print ("% s \ n", txt); - केवल पाठ + "\ n" stdout में, उपसर्ग और रंग के बिना, लॉग के विपरीत ()
• "मुद्रक" = g_printerr ("% s \ n", txt) - प्रिंट से अंतर यह है कि stderr में

लेकिन बॉक्स से बाहर स्पाइडरमंकी के लिए कोई डिबगर नहीं है (यह व्यर्थ नहीं था कि मैंने श्रमसाध्य रूप से लॉगिंग के लिए सभी उपलब्ध उपकरणों के ऊपर लिखा था, इसका उपयोग करें!)। यदि वांछित है, तो आप JSRDbg की कोशिश कर सकते हैं: एक , दो ।

क्या GNOME शेल के बाहर JS कोड के लिए जीवन है?

वहाँ है एक ग्राफिकल यूजर इंटरफेस (जीयूआई) सहित पूर्ण विशेषताओं वाले एप्लिकेशन, जावास्क्रिप्ट में लिखे जा सकते हैं! आपको जीएस बिनार, जेएस-जीटीके कोड लांचर, जीयूआई विंडो बनाने का एक उदाहरण का उपयोग करके उन्हें चलाने की आवश्यकता है:

 $ which gjs /usr/bin/gjs $ dpkg --search /usr/bin/gjs gjs: /usr/bin/gjs $ cat gtk.js const Gtk = imports.gi.Gtk; Gtk.init(null); let win = new Gtk.Window(); win.connect("delete-event", () => { Gtk.main_quit(); }); win.show_all(); Gtk.main(); $ gjs gtk.js 

ऊपर, मैंने मॉड्यूल में विभाजन कोड का उल्लेख किया और उन्हें जावास्क्रिप्ट से लोड किया। सवाल उठता है, लेकिन मॉड्यूल में यह निर्धारित करने के लिए कि यह "मुख्य" मॉड्यूल के रूप में लॉन्च किया गया है या किसी अन्य मॉड्यूल से लोड किया गया है?

अजगर का एक प्रामाणिक निर्माण है:

 if __name__ == "__main__": main() 

Node.js में - इसी तरह:

 if (require.main === module) { main(); } 

मुझे इस सवाल का आधिकारिक उत्तर Gjs / GH के लिए नहीं मिला, लेकिन मैं एक ऐसी तकनीक लेकर आया हूं जिसे मैं पाठक के साथ साझा करने में जल्दबाजी करता हूं (किसी ने "डॉसियूडोवा" क्यों पढ़ा? सम्मान!)।

तो, मुश्किल चाल वर्तमान कॉल स्टैक के विश्लेषण पर आधारित है, अगर इसमें 2 या अधिक लाइनें शामिल हैं, तो हम मुख्य () मॉड्यूल में नहीं हैं:

 if ( new Error().stack.split(/\r\n|\r|\n/g).filter(line => line.length > 0) .length == 1 ) { main(); } 

साफ़

प्रत्येक गनोम शैल विस्तार में पूरे गनोम शैल में सभी वस्तुओं तक पहुंच होती है। उदाहरण के लिए, अभी भी बिना पढ़े सूचनाओं की संख्या प्रदर्शित करने के लिए, हम उनके साथ कंटेनर में जाते हैं Notification Area , ऊपर केंद्र में स्थित, चित्र में नंबर 4 (वर्तमान समय के साथ शिलालेख पर क्लिक करें, यह वास्तविक जीवन में क्लिक करने योग्य है, यहां नहीं):

  let unseenlist = Main.panel.statusArea.dateMenu._messageList._notificationSection._list; 

आप पता लगा सकते हैं कि कितने, अपठित सूचनाएं, सूचनाएं जोड़ने और हटाने की घटनाओं के लिए सदस्यता लें:

 let number = unseenlist.get_n_children(); unseenlist.connect("actor-added", () => { log("added!"); }); unseenlist.connect("actor-removed", () => { log("removed!"); }); 

यह ठीक है, लेकिन उपयोगकर्ता कभी-कभी यह तय कर सकता है कि उसे अब एक्स एक्सटेंशन की आवश्यकता नहीं है, और एक्सटेंशन को अक्षम करने के लिए बटन पर क्लिक करता है। एक एक्सटेंशन के लिए, यह डिसेबल () फ़ंक्शन को कॉल करने के बराबर है, और हर प्रयास किया जाना चाहिए ताकि चालू-बंद एक्सटेंशन कार्यशील जीएच को तोड़ न सके:

 function disable() { dndButton.destroy(); } 

इस मामले में, स्वयं बटन को हटाने के अलावा, आपको उदाहरण के लिए "अभिनेता-जोड़ा" / "अभिनेता-हटाए गए" घटनाओं से सदस्यता समाप्त करने की आवश्यकता है:

 var signal = unseenlist.connect("actor-added", () => { log("added!"); }); function disable() { dndButton.destroy(); unseenlist.disconnect(signal); } 

यदि ऐसा नहीं किया जाता है, तो हैंडलर का कोड इसी घटना पर कॉल करना जारी रखेगा, मेनू बटन की स्थिति को अपडेट करने का प्रयास करें जो पहले से मौजूद नहीं है और ... गनोम शेल विफल होना शुरू हो जाएगा। ठीक है, हाँ, हम इसे करेंगे, उपयोगकर्ता कसम खाएंगे, पत्थर सामान्य रूप से GNOME शेल डेवलपर्स और GNOME को उड़ेंगे। असली तस्वीर, ठा।

इसलिए गनोम शैल / जीजे दो प्रणालियों, ग्लिब / जीटीके और जावास्क्रिप्ट का सहजीवन है, और उनके पास संसाधन प्रबंधन के लिए एक अलग दृष्टिकोण है। ग्लिब / जीटीके को अपने संसाधनों (बटन, टाइमर आदि) के स्पष्ट रिलीज की आवश्यकता होती है। यदि ऑब्जेक्ट जावास्क्रिप्ट इंजन द्वारा बनाया गया था, तो हम हमेशा की तरह कार्य करते हैं (कुछ भी जारी नहीं करते हैं)।

नतीजतन, जैसे ही हमारा एक्सटेंशन तैयार होता है, और "प्रवाह" नहीं होता है, आप इसे https://extensions.gnome.org पर सुरक्षित रूप से प्रकाशित कर सकते हैं।

GnomeSession.PresenceStatus.BUSY और DBus मोड।

यदि आप नहीं भूले हैं, तो हम "डू नॉट डिस्टर्ब" एक्सटेंशन कर रहे हैं, जो उपयोगकर्ता को सूचनाओं के प्रदर्शन को बंद कर देता है।

GNOME के ​​पास पहले से ही इस राज्य के लिए एक ध्वज है। उपयोगकर्ता लॉगिन के बाद, सूक्ति-सत्र प्रक्रिया बनाई जाती है, जिसमें यह ध्वज स्थित है: यह GsmPresencePStreet.status विशेषता है, सूक्ति-सत्र, सूक्ति-सत्र / gsm-present.c के स्रोतों को देखें। हम डीबीस इंटरफेस (इस तरह के इंटरप्रोसेस संचार) के माध्यम से इस ध्वज तक पहुंच प्राप्त करते हैं।

न केवल हमें, बल्कि जीएच को सूचनाओं को न दिखाने के लिए इस ध्वज की जानकारी चाहिए। यह जीएच स्रोत में खोजने के लिए काफी आसान है:

 this._presence = new GnomeSession.Presence((proxy, error) => { this._onStatusChanged(proxy.status); }); ... this._presence.connectSignal('StatusChanged', (proxy, senderName, [status]) => { this._onStatusChanged(status); }); 

इस मामले में, _onStatusChanged विधि एक हैंडलर है जो राज्य परिवर्तन का जवाब देती है। हम इस कोड को स्वयं कॉपी करते हैं, इसे अनुकूलित करते हैं - हमने ⁴ सूचनाओं का पता लगाया, एक ध्वनि थी।

म्यूट / अनम्यूट करें

अधिकांश आधुनिक लिनक्स डेस्कटॉप पल्सएडियो द्वारा नियंत्रित होते हैं, कुख्यात काम कुख्यात लेनार्ट पोएटरिंग के कार्यक्रम के लेखक। अब तक, मैं PulseAudio कोड लिखने के लिए आस-पास नहीं आया था, और मुझे कुछ स्तर पर PulseAudio को समझने का अवसर मिला।

परिणामस्वरूप, यह निकला कि म्यूट / अनम्यूट के लिए, एक pactl उपयोगिता pactl , या इसके आधार पर तीन आदेश दिए गए हैं:

• "pactl info": default sink पता लगाएं - जो ध्वनि आउटपुट है, यदि कई हैं, तो डिफ़ॉल्ट ध्वनि है
• "पैक्ट लिस्ट सिंक": संबंधित डिवाइस की म्यूट / अनम्यूट स्थिति का पता लगाएं
• "पैक्टल सेट-सिंक-म्यूट% (डिफॉल्ट सिंक) s% (isMute) s": म्यूट / अनट्यूट के लिए

इसलिए, हमारा कार्य कमांड / प्रक्रियाएं चलाना है, उनके आउटपुट स्टडआउट को पढ़ना है और नियमित आधार पर वांछित मूल्यों की खोज करना है। संक्षेप में, एक मानक कार्य।

गनोम में, ग्लिब कोर लाइब्रेरी प्रक्रियाओं को बनाने के लिए जिम्मेदार है, और इस पर उत्कृष्ट प्रलेखन है। और निश्चित रूप से वह सी में है और हमारे पास जेएस है। यह ज्ञात है कि Gjs पैकेज ने C-API और जावास्क्रिप्ट के बीच एक स्मार्ट, "सहज" परत बनाई थी। लेकिन आप अभी भी समझते हैं कि आपको उदाहरणों की आवश्यकता है और आप बिना गॉगलिंग के नहीं कर सकते।

नतीजतन, उत्कृष्ट जिस्ट के लिए धन्यवाद , हमें वर्किंग कोड मिलता है:

 let resList = GLib.spawn_command_line_sync(cmd); // res = true/false, /   // status = int,    // out/err = ,  stdout/stderr  let [res, out, err, status] = resList; if (res != true || status != 0) { print("not ok!"); } else { // do something useful } 

बचत सेटिंग्स रजिस्ट्री में

निश्चित रूप से, लिनक्स में कोई रजिस्ट्री नहीं है। यहां आप विंडोज नहीं हैं। एक बेहतर एक है, जिसे GSettings (यह एपीआई है) कहा जाता है, इसके पीछे कई कार्यान्वयन विकल्प छिपे हुए हैं, डिफ़ॉल्ट रूप से GNOME जोंक का उपयोग करता है। यह वही है जो GUI फ्रेमवर्क इसके लिए दिखता है:

- प्लेन टेक्स्ट फाइल्स में सेटिंग्स को स्टोर करने से बेहतर क्या है? - पुराने और दाढ़ी वाले लिनक्स उपयोगकर्ताओं से पूछें। GSettings की मुख्य विशेषता यह है कि आप आसानी से सेटिंग्स में बदलाव के लिए सदस्यता ले सकते हैं, उदाहरण के लिए:

 const Gio = imports.gi.Gio; settings = new Gio.Settings({ settings_schema: schemaObj }); settings.connect("changed::mute-audio", function() { log("I see, you changed it!"); }); 

हमारे "डू नॉट डिस्टर्ब" में अब तक की एकमात्र सेटिंग "म्यूट-ऑडियो" विकल्प है, जो उपयोगकर्ता को "शांत घंटे" या उपयोगकर्ता के अनुरोध पर ध्वनि बंद करने की अनुमति देता है।

और थोड़ा क्लासिक, जीटीके जीयूआई

उपयोगकर्ता को हमारे एक्सटेंशन की सेटिंग्स (और गंदे पंजे के साथ रजिस्ट्री में नहीं मिलें) को खूबसूरती से दिखाने के लिए, GH हमें GUI कोड लिखने और इसे प्रीफ़ेक्स् फाइल के buildPrefsWidget () फ़ंक्शन में लिखने की पेशकश करता है। इस स्थिति में, "इंस्टॉल किए गए एक्सटेंशन" की सूची में हमारे एक्सटेंशन के विपरीत हम यहां एक अतिरिक्त बटन "इस एक्सटेंशन को कॉन्फ़िगर करें" देखेंगे, जिस पर क्लिक करके हमारी सुंदरता दिखाई देगी।

आइए एक अलग About टैब बनाएं, क्योंकि यह ज्ञात है कि Ebout के बिना, क्षमा करें, प्रोग्राम पूरा नहीं हुआ है।

आम तौर पर, एक क्लासिक ग्राफिकल इंटरफ़ेस बनाने के लिए, जीटीके में बिल्डिंग ब्लॉक, की एक पूरी श्रृंखला है, जिसे आप यहां की मात्रा और गुणवत्ता की जांच कर सकते हैं ।

हम उनमें से केवल कुछ का उपयोग करेंगे:

• Gtk.Notebook एक टैब है, जैसे ब्राउज़र में
• Gtk.VBox विगेट्स की सूची को लंबवत रूप से संरचित करने के लिए एक कंटेनर है
• Gtk.Label एक मूल तत्व, एक शिलालेख है, जिसमें HTML प्रारूपित करने की क्षमता है

 function buildPrefsWidget() { //    Gtk.Notebook    GUI let notebook = new Gtk.Notebook(); ... //  About,    VBox c   10 , //   margin/padding   let aboutBox = new Gtk.VBox({ border_width: 10 }); //     About notebook.append_page( aboutBox, new Gtk.Label({label: "About"}), ); //        , //      ,    (expand) aboutBox.pack_start( new Gtk.Label({ label: "<b>Do Not Disturb Time</b>", use_markup: true, }), true, // expand true, // fill 0, ); ... notebook.show_all(); return notebook; } 

अंतिम स्क्रीनशॉट:

इसके साथ ही