a622aba7eb
The "extension" object is what I previously called the "helper" object.
It contains the extension importer object as well as the metadata object.
Things that were previously added on to the metadata (state, path, dir, etc.)
are now part of this new "extension" object.
With the new importer changes brought on by the extension prefs tool,
extensions are left without a way to import submodules at the global scope,
which would make them rely on techniques like:
var MySubModule;
function init(meta) {
MySubModule = meta.importer.mySubModule;
}
That is, there's now a lot more meaningless boilerplate that nobody wants
to write and nobody wants to reivew.
Let's solve this with a few clever hacks.
Allow extensions to get their current extension object with:
let extension = imports.misc.extensionUtils.getCurrentExtension();
As such, extensions can now get their own extension object before the
'init' method is called, so they can import submodules or do other things
at the module scope:
const MySubModule = extension.imports.mySubModule;
const dataPath = GLib.build_filenamev([extension.path, 'awesome-data.json']);
https://bugzilla.gnome.org/show_bug.cgi?id=668429
291 lines
9.5 KiB
JavaScript
291 lines
9.5 KiB
JavaScript
// -*- mode: js; js-indent-level: 4; indent-tabs-mode: nil -*-
|
|
|
|
const Lang = imports.lang;
|
|
const Gio = imports.gi.Gio;
|
|
const GLib = imports.gi.GLib;
|
|
const Shell = imports.gi.Shell;
|
|
|
|
const Config = imports.misc.config;
|
|
const ExtensionSystem = imports.ui.extensionSystem;
|
|
const ExtensionUtils = imports.misc.extensionUtils;
|
|
const Flashspot = imports.ui.flashspot;
|
|
const Main = imports.ui.main;
|
|
|
|
const GnomeShellIface = <interface name="org.gnome.Shell">
|
|
<method name="Eval">
|
|
<arg type="s" direction="in" name="script" />
|
|
<arg type="b" direction="out" name="success" />
|
|
<arg type="s" direction="out" name="result" />
|
|
</method>
|
|
<method name="ListExtensions">
|
|
<arg type="a{sa{sv}}" direction="out" name="extensions" />
|
|
</method>
|
|
<method name="GetExtensionInfo">
|
|
<arg type="s" direction="in" name="extension" />
|
|
<arg type="a{sv}" direction="out" name="info" />
|
|
</method>
|
|
<method name="GetExtensionErrors">
|
|
<arg type="s" direction="in" name="extension" />
|
|
<arg type="as" direction="out" name="errors" />
|
|
</method>
|
|
<method name="ScreenshotArea">
|
|
<arg type="i" direction="in" name="x"/>
|
|
<arg type="i" direction="in" name="y"/>
|
|
<arg type="i" direction="in" name="width"/>
|
|
<arg type="i" direction="in" name="height"/>
|
|
<arg type="b" direction="in" name="flash"/>
|
|
<arg type="s" direction="in" name="filename"/>
|
|
<arg type="b" direction="out" name="success"/>
|
|
</method>
|
|
<method name="ScreenshotWindow">
|
|
<arg type="b" direction="in" name="include_frame"/>
|
|
<arg type="b" direction="in" name="flash"/>
|
|
<arg type="s" direction="in" name="filename"/>
|
|
<arg type="b" direction="out" name="success"/>
|
|
</method>
|
|
<method name="Screenshot">
|
|
<arg type="b" direction="in" name="flash"/>
|
|
<arg type="s" direction="in" name="filename"/>
|
|
<arg type="b" direction="out" name="success"/>
|
|
</method>
|
|
<method name="EnableExtension">
|
|
<arg type="s" direction="in" name="uuid"/>
|
|
</method>
|
|
<method name="DisableExtension">
|
|
<arg type="s" direction="in" name="uuid"/>
|
|
</method>
|
|
<method name="InstallRemoteExtension">
|
|
<arg type="s" direction="in" name="uuid"/>
|
|
<arg type="s" direction="in" name="version"/>
|
|
</method>
|
|
<method name="UninstallExtension">
|
|
<arg type="s" direction="in" name="uuid"/>
|
|
<arg type="b" direction="out" name="success"/>
|
|
</method>
|
|
<method name="LaunchExtensionPrefs">
|
|
<arg type="s" direction="in" name="uuid"/>
|
|
</method>
|
|
<property name="OverviewActive" type="b" access="readwrite" />
|
|
<property name="ApiVersion" type="i" access="read" />
|
|
<property name="ShellVersion" type="s" access="read" />
|
|
<signal name="ExtensionStatusChanged">
|
|
<arg type="s" name="uuid"/>
|
|
<arg type="i" name="state"/>
|
|
<arg type="s" name="error"/>
|
|
</signal>
|
|
</interface>;
|
|
|
|
const GnomeShell = new Lang.Class({
|
|
Name: 'GnomeShellDBus',
|
|
|
|
_init: function() {
|
|
this._dbusImpl = Gio.DBusExportedObject.wrapJSObject(GnomeShellIface, this);
|
|
this._dbusImpl.export(Gio.DBus.session, '/org/gnome/Shell');
|
|
ExtensionSystem.connect('extension-state-changed',
|
|
Lang.bind(this, this._extensionStateChanged));
|
|
},
|
|
|
|
/**
|
|
* Eval:
|
|
* @code: A string containing JavaScript code
|
|
*
|
|
* This function executes arbitrary code in the main
|
|
* loop, and returns a boolean success and
|
|
* JSON representation of the object as a string.
|
|
*
|
|
* If evaluation completes without throwing an exception,
|
|
* then the return value will be [true, JSON.stringify(result)].
|
|
* If evaluation fails, then the return value will be
|
|
* [false, JSON.stringify(exception)];
|
|
*
|
|
*/
|
|
Eval: function(code) {
|
|
if (!global.settings.get_boolean('development-tools'))
|
|
return [false, null];
|
|
|
|
let returnValue;
|
|
let success;
|
|
try {
|
|
returnValue = JSON.stringify(eval(code));
|
|
// A hack; DBus doesn't have null/undefined
|
|
if (returnValue == undefined)
|
|
returnValue = '';
|
|
success = true;
|
|
} catch (e) {
|
|
returnValue = JSON.stringify(e);
|
|
success = false;
|
|
}
|
|
return [success, returnValue];
|
|
},
|
|
|
|
_onScreenshotComplete: function(obj, result, area, flash, invocation) {
|
|
if (flash) {
|
|
let flashspot = new Flashspot.Flashspot(area);
|
|
flashspot.fire();
|
|
}
|
|
|
|
let retval = GLib.Variant.new('(b)', [result]);
|
|
invocation.return_value(retval);
|
|
},
|
|
|
|
/**
|
|
* ScreenshotArea:
|
|
* @x: The X coordinate of the area
|
|
* @y: The Y coordinate of the area
|
|
* @width: The width of the area
|
|
* @height: The height of the area
|
|
* @filename: The filename for the screenshot
|
|
*
|
|
* Takes a screenshot of the passed in area and saves it
|
|
* in @filename as png image, it returns a boolean
|
|
* indicating whether the operation was successful or not.
|
|
*
|
|
*/
|
|
ScreenshotAreaAsync : function (params, invocation) {
|
|
let [x, y, width, height, flash, filename, callback] = params;
|
|
global.screenshot_area (x, y, width, height, filename,
|
|
Lang.bind(this, this._onScreenshotComplete,
|
|
flash, invocation));
|
|
},
|
|
|
|
/**
|
|
* ScreenshotWindow:
|
|
* @include_frame: Whether to include the frame or not
|
|
* @filename: The filename for the screenshot
|
|
*
|
|
* Takes a screenshot of the focused window (optionally omitting the frame)
|
|
* and saves it in @filename as png image, it returns a boolean
|
|
* indicating whether the operation was successful or not.
|
|
*
|
|
*/
|
|
ScreenshotWindowAsync : function (params, invocation) {
|
|
let [include_frame, flash, filename] = params;
|
|
global.screenshot_window (include_frame, filename,
|
|
Lang.bind(this, this._onScreenshotComplete,
|
|
flash, invocation));
|
|
},
|
|
|
|
/**
|
|
* Screenshot:
|
|
* @filename: The filename for the screenshot
|
|
*
|
|
* Takes a screenshot of the whole screen and saves it
|
|
* in @filename as png image, it returns a boolean
|
|
* indicating whether the operation was successful or not.
|
|
*
|
|
*/
|
|
ScreenshotAsync : function (params, invocation) {
|
|
let [flash, filename] = params;
|
|
global.screenshot(filename,
|
|
Lang.bind(this, this._onScreenshotComplete,
|
|
flash, invocation));
|
|
},
|
|
|
|
ListExtensions: function() {
|
|
let out = {};
|
|
for (let uuid in ExtensionUtils.extensions) {
|
|
let dbusObj = this.GetExtensionInfo(uuid);
|
|
out[uuid] = dbusObj;
|
|
}
|
|
return out;
|
|
},
|
|
|
|
GetExtensionInfo: function(uuid) {
|
|
let extension = ExtensionUtils.extensions[uuid];
|
|
if (!extension)
|
|
return {};
|
|
|
|
let obj = {};
|
|
Lang.copyProperties(extension.metadata, obj);
|
|
|
|
// Only serialize the properties that we actually need.
|
|
const serializedProperties = ["type", "state", "path", "error", "hasPrefs"];
|
|
|
|
serializedProperties.forEach(function(prop) {
|
|
obj[prop] = extension[prop];
|
|
});
|
|
|
|
let out = {};
|
|
for (let key in obj) {
|
|
let val = obj[key];
|
|
let type;
|
|
switch (typeof val) {
|
|
case 'string':
|
|
type = 's';
|
|
break;
|
|
case 'number':
|
|
type = 'd';
|
|
break;
|
|
case 'boolean':
|
|
type = 'b';
|
|
break;
|
|
default:
|
|
continue;
|
|
}
|
|
out[key] = GLib.Variant.new(type, val);
|
|
}
|
|
|
|
return out;
|
|
},
|
|
|
|
GetExtensionErrors: function(uuid) {
|
|
let extension = ExtensionUtils.extensions[uuid];
|
|
if (!extension)
|
|
return [];
|
|
|
|
if (!extension.errors)
|
|
return [];
|
|
|
|
return extension.errors;
|
|
},
|
|
|
|
EnableExtension: function(uuid) {
|
|
let enabledExtensions = global.settings.get_strv(ExtensionSystem.ENABLED_EXTENSIONS_KEY);
|
|
if (enabledExtensions.indexOf(uuid) == -1)
|
|
enabledExtensions.push(uuid);
|
|
global.settings.set_strv(ExtensionSystem.ENABLED_EXTENSIONS_KEY, enabledExtensions);
|
|
},
|
|
|
|
DisableExtension: function(uuid) {
|
|
let enabledExtensions = global.settings.get_strv(ExtensionSystem.ENABLED_EXTENSIONS_KEY);
|
|
while (enabledExtensions.indexOf(uuid) != -1)
|
|
enabledExtensions.splice(enabledExtensions.indexOf(uuid), 1);
|
|
global.settings.set_strv(ExtensionSystem.ENABLED_EXTENSIONS_KEY, enabledExtensions);
|
|
},
|
|
|
|
InstallRemoteExtension: function(uuid, version_tag) {
|
|
ExtensionSystem.installExtensionFromUUID(uuid, version_tag);
|
|
},
|
|
|
|
UninstallExtension: function(uuid) {
|
|
return ExtensionSystem.uninstallExtensionFromUUID(uuid);
|
|
},
|
|
|
|
LaunchExtensionPrefs: function(uuid) {
|
|
let appSys = Shell.AppSystem.get_default();
|
|
let app = appSys.lookup_app('gnome-shell-extension-prefs.desktop');
|
|
app.launch(global.display.get_current_time_roundtrip(),
|
|
['extension:///' + uuid], -1, null);
|
|
},
|
|
|
|
get OverviewActive() {
|
|
return Main.overview.visible;
|
|
},
|
|
|
|
set OverviewActive(visible) {
|
|
if (visible)
|
|
Main.overview.show();
|
|
else
|
|
Main.overview.hide();
|
|
},
|
|
|
|
ApiVersion: ExtensionSystem.API_VERSION,
|
|
|
|
ShellVersion: Config.PACKAGE_VERSION,
|
|
|
|
_extensionStateChanged: function(_, newState) {
|
|
this._dbusImpl.emit_signal('ExtensionStatusChanged',
|
|
GLib.Variant.new('(sis)', [newState.uuid, newState.state, newState.error]));
|
|
}
|
|
});
|