Plugins

Differences between revisions 1 and 16 (spanning 15 versions)
Revision 1 as of 2009-07-17 17:34:14
Size: 7996
Editor: bismuth
Comment:
Revision 16 as of 2009-08-21 19:54:35
Size: 11543
Editor: 65-78-0-53
Comment:
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
 * The ability to stop going forward (say, a EULA page that requires an approval checkbox). Might as well through in stopping going back.  * The ability to prevent going forward (say, a EULA page that requires an approval checkbox). Might as well also allow preventing going back.
Line 14: Line 14:
 * Allow plugins to be pure Python (no required shell)
Line 32: Line 33:
It can install the UI files (.glade, .ui) anywhere it wants. The plugin will have UI classes like 'PageGtk' or 'PageKde' or 'PageNoninteractive' which will be instantiated by Ubiquity and passed to the filter class. If the right class for the current frontend isn't find, the plugin is ignored. For GUI frontends, a method {{{get_ui()}}} can be called to get the frontend-specific UI object (for GTK, a tuple of the top-level name and the glade xml object). The GTK frontend will load and connect the glade file itself. The plugin will have UI classes like 'PageGtk' or 'PageKde' or 'PageNoninteractive' which will be instantiated by Ubiquity and passed to the filter class. If the right class for the current frontend isn't find, the plugin is ignored. For GUI frontends, a method {{{get_ui()}}} can be called to get frontend-specific objects and info. This will return a dictionary object with keys that the frontend knows. For GTK+, 'widgets' containing a list of pages and other information. See below for more details.

The
plugin can install the UI files (.glade, .ui) anywhere it wants, because it is responsible for loading it. The GTK and KDE frontends only want to see actual widgets.
Line 36: Line 39:
Can use its own debconf template. Ubiquity will do the translation for it, from its template. Plugins can use their own debconf template. Ubiquity will do the translation for it, from its template.
Line 40: Line 43:
Plugins can drop the filter in /usr/lib/ubiquity/plugins.d/

=== How to add/remove pages ===

There are four major options here:
 0. Require some third party to specify a hard list of pages. This could be done via preseeding the appropriate page list that Ubiquity uses (there's one for Ubiquity and one for OEM-config).
 0. Only allow one plugin (though it could still use multiple pages). This plugin would own the mechanism for specifying a page list (much like the above, but could be via a well-known file like /etc/ubiquity/pages).
 0. Have some syntax for saying a page should be before this page, but after this page. Sort of like how upstart lets your order jobs, but way simpler. Could reference either standard pages or other plugin pages. If Ubiquity can't figure out how to order the plugin, it just won't show it. Additionally would need to allow a plugin to list pages it wants to hide.
 0. Use filesystem ordering, like have plugins use plugins.d/10-mypage and 22-otherpage. The standard pages would need to have standard numbers. Which has all sorts of difficulties if we ever tried to add, remove, or reorder a standard page. All plugins would need to change. Could use a separate directory like plugins.hide.d/mypage to hide pages.

The first two options above are best suited for OEM installs, where one entity is crafting the experience. But the latter two options are slightly better for Ubuntu itself where it's easier for derivatives and packagers to plug into the existing system on a dynamic 'am-I-installed' basis. Seeds would do the rest of the job. Even here though, there is tight control over the experience. The first two options could still work.

I think option 3 above gives us the most flexibility for the least cost. The syntax can be dreadfully simple: only allow one 'after' ''or'' 'before' statement, and it would reference the python module for the page (reducing complexity for things like the partitioner that have 2 UI files, but one module. So, for example:
{{{
from ubiquity.components import language
AFTER=language.Language
}}}

Pages can be hidden from a HIDE list (a non-list would also work):
{{{
from ubiquity.components import language, timezone
HIDE=[language.Language, timezone.Timezone]
}}}

Ties (where two pages specify 'after language' for example) can be broken by file system ordering in plugins.d (ala option 4 above). Thus, Ubiquity just has to read those in in order, and everything just works. The number before the filename can be considered a priority then for ties. i.e. if both 10-mypage and 22-otherpage specify {{{AFTER=language.Language}}}, 22 would be first, then 10.

 * If neither AFTER or BEFORE are specified, the page will not be used, but may still specify other plugin options, like HIDE.
 * If both are specified, Ubiquity will just take use AFTER.
 * If AFTER/BEFORE specify a page that isn't being used, the page is ignored (and other plugin options like HIDE are '''not''' used -- it's likely this page is optional, pending installation of some package we don't have or was written for an older Ubiquity).
Plugins drop python page files in /usr/lib/ubiquity/plugins.d/

=== How to order/add/remove pages ===

Plugins has a module-wide NAME field that specifies a name to use. The recommended NAME for pages would be similar to the module name that defines the page. For third-party plugins, using a namespace (e.g. 'foo-page' and 'foo-page2') is recommended.

To insert your page into the sequence of pages, use AFTER or BEFORE fields.
{{{
AFTER='goober-language'
BEFORE=['language', None]
}}}

Pages can be hidden from a HIDDEN field (a list would also work):
{{{
HIDDEN='language'
}}}

 * If neither AFTER or BEFORE are specified, the page will not be used, but may still specify other plugin options, like HIDDEN. (i.e. a page that only hides, and does not insert itself)
 * If AFTER or BEFORE is a list of names, the first component that Ubiquity recognizes is used.
 * If both AFTER and BEFORE are specified, Ubiquity will use AFTER if it recognizes it, else use BEFORE.
 * If Ubiquity still can't find a value that it recognizes, the page is ignored (and other plugin options like HIDDEN are '''not''' used -- it's likely this page is optional, pending installation of some package we don't have or was written for an older Ubiquity).
 * If AFTER's value is None or otherwise 'Python-false', it is inserted at the beginning of the page sequence.
 * If BEFORE's value is None or otherwise 'Python-false', it is inserted at the end of the page sequence.

Ties (where two pages specify 'after language' for example) are broken by file system ordering in plugins.d. Ubiquity reads the plugins.d files in order, and resolves names as they come in. The number before the filename can thus be considered a priority then for ties. i.e. if both 10-mypage and 22-otherpage specify {{{AFTER=language}}}, 22 would be first in the resulting sequence, then 10.
Line 72: Line 71:
The PageGtk class must provide an __init__ that takes at least one argument. Additional keyword arguments are allowed, but not currently used. The PageGtk class must provide an init that takes at least one argument. Additional keyword arguments are allowed, but not currently used.
Line 76: Line 75:
It must provide a method called {{{get_ui(self)}}} that returns a tuple of (string, gtk.glade.XML), where the string specifies the name of the top-level page widget in the glade XML. It must provide a method called {{{get_ui(self)}}} that returns a dictionary. Here's a list of the supported keys:

 * '''widgets''': A GTK+ widget or a list of widgets to show as pages
 * '''optional_widgets''': A GTK+ widget or a list of widgets that aren't likely to be shown. These widgets don't add to the step count in the bottom left of the UI (step X of Y), but can be shown via {{{get_current_page}}} as described below.
 * '''is_language_page''': Indicates that 'widgets' describes a page that will possibly change the language. This is used to cache all possible translations for the widgets on the page.
 * '''prefix''': Indicates a debconf template prefix to use for widget names when translating. Ubiquity will look up 'prefix/name' and use the string debconf gives as the UI translation.

It may provide a method called {{{get_current_page(self)}}} that will return which of the widgets in '''widgets''' or '''optional_widgets''' should be shown now. If not defined, the first in the lists will be used.

=== PageKde Design ===

The PageKde class must provide an init that takes at least one argument. Additional keyword arguments are allowed, but not currently used.

This first argument is a 'controller' class, specified below. This is how PageKde can provide feedback to the 'real' frontend.

It must provide a method called {{{get_ui(self)}}} that returns a dictionary. Here's a list of the supported keys:

 * '''widgets''': A Qt widget or a list of widgets to show as pages
 * '''breadcrumb''': A debconf template key for the list of stages on the left of the UI. Setting 'breadcrumb' to None indicates that you don't want the breadcrumb list visible for your page.
 * '''is_language_page''': Indicates that 'widgets' describes a page that will possibly change the language. This is used to cache all possible translations for the widgets on the page.
 * '''prefix''': Indicates a debconf template prefix to use for widget names when translating. Ubiquity will look up 'prefix/name' and use the string debconf gives as the UI translation.

It may provide a method called {{{get_current_page(self)}}} that will return which of the widgets in '''widgets''' should be shown now. If not defined, the first in the lists will be used.
Line 80: Line 101:
The controller object passed to Page frontend classes is a simple mechanism for talking to the main frontend. Right now the only methods allowed are:

allow_go_forward(bool)
allow_go_backward(bool)

This may or may not be the main frontend object (which already has these functions), depending on how paranoid we are when implementing it.

=== Open Questions ===
 * What about the apply() method and progress? Do we want to expose a string to show to user while Ubiquity is apply'ing the plugins? And allow progress reporting? Or do we just say 'plugins should apply quickly'?
The controller object passed to Page UI classes is a simple mechanism for talking to the main frontend.

Here are the currently defined members:
 * dbfilter (lets you have access to your Page class)
 * oem_config
 * oem_user_config (flags for which mode we're in)

And the methods:
 * translate(self, lang=None, just_me=True, reget=False) (retranslate the UI)
 * allow_go_forward(self, bool) (page starts with forward allowed)
 * allow_go_backward(self, bool) (page starts with backward allowed)
 * go_forward(self) (clicks forward)
 * go_backward(self) (clicks back)
 * go_to_page(self, page) (jumps to the given page)

=== Applying the Page ===

If your plugin wants to perform install-time work, it can define a {{{Install}}} class that derives from the {{{InstallPlugin}}} class.

{{{InstallPlugin}}} is a {{{Plugin}}} and follows the same conventions -- it is a debconf filter that has {{{prepare}}} and {{{cleanup}}} methods. But additionally and more relevantly for us, it adds an {{{install}}} method.

{{{install}}} is passed a target directory (usually '/target' or '/'), a progress class (more on that below), and possibly some future arguments. It's recommended that plugins use *args and **kwargs to gracefully handle future extensions.

If {{{install}}} returns a Python-true value, it is considered an error (ala command line programs). The error value (a string or a number) will be printed to syslog.

==== Progress API ====

{{{install}}} is passed a progress class that can provide updates on what your plugin is doing. Currently, it only supports passing a text description. Each plugin takes up 1% on the install progress bar.

{{{
#!Python
def info(self, title):
    pass
}}}

==== Install Example ====

{{{
#!Python
def install(self, target, progress, *args, **kwargs):
    progress.info('ubiquity/install/timezone')
    return InstallPlugin.install(target, progress, *args, **kwargs)
}}}
Line 94: Line 149:
import gtk
import os
from ubiquity.filteredcommand import Plugin
from ubiquity.components import usersetup
#!Pythonimport os
from ubiquity.plugin import *
Line 100: Line 153:
BEFORE=usersetup.UserSetup NAME='foo'
AFTER='language'
Line 104: Line 158:
        import gtk
Line 105: Line 160:
        self.gladexml = gtk.glade.XML('/usr/share/ubiquity-foo/foo.glade', 'foo')         self.page = gtk.CheckButton()
        self.page.set_name("paranoid-mode")
Line 107: Line 164:
        return ('foo', self.gladexml)

    # Custom foo controls
    def get_bar(self):
        button = self.gladexml.get_widget('bar')
        return button.get_active()
    def set_bar(self, on):
        button = self.gladexml.get_widget('bar')
        button.set_active(on)
        return {'widgets': self.page, 'prefix': 'tcpd'}

    # Custom controls
    def get_mode(self):
        return self.page.get_active()
    def set_mode(self, on):
        self.page.set_active(on)

class PageKde:
    def __init__(self, controller):
        from PyQt4.QtGui import QCheckBox
        self.controller = controller
        self.page = QCheckBox()
        self.page.setObjectName("paranoid-mode")

    def get_ui(self):
        return {'widgets': self.page,
                # Just chosen because it's short and different. You can use
                # any template name here -- it's not affected by prefix.
                'breadcrumb': 'ubiquity/text/ready_details_label',
                'prefix': 'tcpd'}

    # Custom controls
    def get_mode(self):
        from PyQt4.QtCore import Qt
        return self.page.checkState() == Qt.Checked
    def set_mode(self, on):
        from PyQt4.QtCore import Qt
        self.page.setCheckState(Qt.Checked if on else Qt.Unchecked)
Line 120: Line 197:
        bar = self.db.get('foo/bar')
        self.frontend.set_bar(bar)
        return ([], ['foo/bar'])
        mode = self.db.get('tcpd/paranoid-mode')
        self.ui.set_mode(mode == 'true')
        return Plugin.prepare(self, unfiltered=unfiltered)
Line 125: Line 202:
        bar = self.frontend.get_bar()
        self.preseed_bool('foo/bar', bar)
        mode = self.ui.get_mode()
        self.preseed_bool('tcpd/paranoid-mode', mode)
Line 129: Line 206:
    def apply(self):
        bar = self.db.get('foo/bar')
        if bar:
            os.system(['touch', '/etc/bar'])
        else:
            os.system(['rm', '/etc/bar'])
}}}
class Install(InstallPlugin):
    def install(self, target, progress, *args, **kwargs):
        progress.info('tcpd/paranoid-mode') # not really appropriate, but just an example
        cmd = 'touch' if self.db.get('tcpd/paranoid-mode') else 'rm'
        rv = os.system('%s %s' % (cmd, os.path.join(target, '/etc/bar')))
        import time
        time.sleep(45) # just to give you time to see this in the progress bar
        if rv:
            return rv
        return InstallPlugin.install(target, progress, *args, **kwargs)
}}}

Here, I describe a possible system for enabling drop-in plugins for Ubiquity and OEM-config.

Requirements

  • Insert a page: The ability to add a page anywhere in the page sequence
  • Hide a page: The ability to stop a standard page from showing up (the combination of inserting/hiding lets you replace a page)
  • The ability to prevent going forward (say, a EULA page that requires an approval checkbox). Might as well also allow preventing going back.
  • Let plugins be translatable
  • Let plugins execute code after user is done entering any info, to actually do what user asks
  • Let plugins offer gtk or kde UI (or debconf or noninteractive, etc if desired)

Wants

  • Reduce plugin's exposure to Ubiquity internals, to make them more change-proof.
  • Allow plugins to be pure Python (no required shell)

Design

What a plugin looks like

Bits of a standard gtk page:

  • A glade file
  • A debconf filter
  • Ask and apply scripts

With the above, by providing the above files, we can do everything a normal page can in a plugin. Assuming Ubiquity knows how to find the files.

The asking can be provided by Ubiquity, as long as the plugin gives us a list of debconf questions to ask. And the apply script could just be done by the filter by a special 'apply' method. Then all a plugin needs is a filter and a UI file.

We could additionally dumb down the python a plugin needs to provide by having them be 'filter lites' custom classes that didn't do everything a filter does. But the filter parent classes already provide good default methods. We should probably have a plugin parent class that sits between the debconf filter and the plugin, just to provide further default methods and any special configuration we need.

How the plugin will talk to its own UI

The plugin will have UI classes like 'PageGtk' or 'PageKde' or 'PageNoninteractive' which will be instantiated by Ubiquity and passed to the filter class. If the right class for the current frontend isn't find, the plugin is ignored. For GUI frontends, a method get_ui() can be called to get frontend-specific objects and info. This will return a dictionary object with keys that the frontend knows. For GTK+, 'widgets' containing a list of pages and other information. See below for more details.

The plugin can install the UI files (.glade, .ui) anywhere it wants, because it is responsible for loading it. The GTK and KDE frontends only want to see actual widgets.

How the plugin is translated

Plugins can use their own debconf template. Ubiquity will do the translation for it, from its template.

How to find the plugin

Plugins drop python page files in /usr/lib/ubiquity/plugins.d/

How to order/add/remove pages

Plugins has a module-wide NAME field that specifies a name to use. The recommended NAME for pages would be similar to the module name that defines the page. For third-party plugins, using a namespace (e.g. 'foo-page' and 'foo-page2') is recommended.

To insert your page into the sequence of pages, use AFTER or BEFORE fields.

AFTER='goober-language'
BEFORE=['language', None]

Pages can be hidden from a HIDDEN field (a list would also work):

HIDDEN='language'
  • If neither AFTER or BEFORE are specified, the page will not be used, but may still specify other plugin options, like HIDDEN. (i.e. a page that only hides, and does not insert itself)
  • If AFTER or BEFORE is a list of names, the first component that Ubiquity recognizes is used.
  • If both AFTER and BEFORE are specified, Ubiquity will use AFTER if it recognizes it, else use BEFORE.
  • If Ubiquity still can't find a value that it recognizes, the page is ignored (and other plugin options like HIDDEN are not used -- it's likely this page is optional, pending installation of some package we don't have or was written for an older Ubiquity).

  • If AFTER's value is None or otherwise 'Python-false', it is inserted at the beginning of the page sequence.
  • If BEFORE's value is None or otherwise 'Python-false', it is inserted at the end of the page sequence.

Ties (where two pages specify 'after language' for example) are broken by file system ordering in plugins.d. Ubiquity reads the plugins.d files in order, and resolves names as they come in. The number before the filename can thus be considered a priority then for ties. i.e. if both 10-mypage and 22-otherpage specify AFTER=language, 22 would be first in the resulting sequence, then 10.

PageGtk Design

The PageGtk class must provide an init that takes at least one argument. Additional keyword arguments are allowed, but not currently used.

This first argument is a 'controller' class, specified below. This is how PageGtk can provide feedback to the 'real' frontend.

It must provide a method called get_ui(self) that returns a dictionary. Here's a list of the supported keys:

  • widgets: A GTK+ widget or a list of widgets to show as pages

  • optional_widgets: A GTK+ widget or a list of widgets that aren't likely to be shown. These widgets don't add to the step count in the bottom left of the UI (step X of Y), but can be shown via get_current_page as described below.

  • is_language_page: Indicates that 'widgets' describes a page that will possibly change the language. This is used to cache all possible translations for the widgets on the page.

  • prefix: Indicates a debconf template prefix to use for widget names when translating. Ubiquity will look up 'prefix/name' and use the string debconf gives as the UI translation.

It may provide a method called get_current_page(self) that will return which of the widgets in widgets or optional_widgets should be shown now. If not defined, the first in the lists will be used.

PageKde Design

The PageKde class must provide an init that takes at least one argument. Additional keyword arguments are allowed, but not currently used.

This first argument is a 'controller' class, specified below. This is how PageKde can provide feedback to the 'real' frontend.

It must provide a method called get_ui(self) that returns a dictionary. Here's a list of the supported keys:

  • widgets: A Qt widget or a list of widgets to show as pages

  • breadcrumb: A debconf template key for the list of stages on the left of the UI. Setting 'breadcrumb' to None indicates that you don't want the breadcrumb list visible for your page.

  • is_language_page: Indicates that 'widgets' describes a page that will possibly change the language. This is used to cache all possible translations for the widgets on the page.

  • prefix: Indicates a debconf template prefix to use for widget names when translating. Ubiquity will look up 'prefix/name' and use the string debconf gives as the UI translation.

It may provide a method called get_current_page(self) that will return which of the widgets in widgets should be shown now. If not defined, the first in the lists will be used.

Controller Design

The controller object passed to Page UI classes is a simple mechanism for talking to the main frontend.

Here are the currently defined members:

  • dbfilter (lets you have access to your Page class)
  • oem_config
  • oem_user_config (flags for which mode we're in)

And the methods:

  • translate(self, lang=None, just_me=True, reget=False) (retranslate the UI)
  • allow_go_forward(self, bool) (page starts with forward allowed)
  • allow_go_backward(self, bool) (page starts with backward allowed)
  • go_forward(self) (clicks forward)
  • go_backward(self) (clicks back)
  • go_to_page(self, page) (jumps to the given page)

Applying the Page

If your plugin wants to perform install-time work, it can define a Install class that derives from the InstallPlugin class.

InstallPlugin is a Plugin and follows the same conventions -- it is a debconf filter that has prepare and cleanup methods. But additionally and more relevantly for us, it adds an install method.

install is passed a target directory (usually '/target' or '/'), a progress class (more on that below), and possibly some future arguments. It's recommended that plugins use *args and **kwargs to gracefully handle future extensions.

If install returns a Python-true value, it is considered an error (ala command line programs). The error value (a string or a number) will be printed to syslog.

Progress API

install is passed a progress class that can provide updates on what your plugin is doing. Currently, it only supports passing a text description. Each plugin takes up 1% on the install progress bar.

   1 def info(self, title):
   2     pass

Install Example

   1 def install(self, target, progress, *args, **kwargs):
   2     progress.info('ubiquity/install/timezone')
   3     return InstallPlugin.install(target, progress, *args, **kwargs)

Example

In /usr/lib/ubiquity/plugins.d/30-foo.py

from ubiquity.plugin import *

# Plugin settings
NAME='foo'
AFTER='language'

class PageGtk:
    def __init__(self, controller):
        import gtk
        self.controller = controller
        self.page = gtk.CheckButton()
        self.page.set_name("paranoid-mode")

    def get_ui(self):
        return {'widgets': self.page, 'prefix': 'tcpd'}

    # Custom controls
    def get_mode(self):
        return self.page.get_active()
    def set_mode(self, on):
        self.page.set_active(on)

class PageKde:
    def __init__(self, controller):
        from PyQt4.QtGui import QCheckBox
        self.controller = controller
        self.page = QCheckBox()
        self.page.setObjectName("paranoid-mode")

    def get_ui(self):
        return {'widgets': self.page,
                # Just chosen because it's short and different.  You can use
                # any template name here -- it's not affected by prefix.
                'breadcrumb': 'ubiquity/text/ready_details_label',
                'prefix': 'tcpd'}

    # Custom controls
    def get_mode(self):
        from PyQt4.QtCore import Qt
        return self.page.checkState() == Qt.Checked
    def set_mode(self, on):
        from PyQt4.QtCore import Qt
        self.page.setCheckState(Qt.Checked if on else Qt.Unchecked)

class Page(Plugin):
    def prepare(self, unfiltered=False):
        # self.frontend is PageGtk above
        mode = self.db.get('tcpd/paranoid-mode')
        self.ui.set_mode(mode == 'true')
        return Plugin.prepare(self, unfiltered=unfiltered)

    def ok_handler(self):
        mode = self.ui.get_mode()
        self.preseed_bool('tcpd/paranoid-mode', mode)
        Plugin.ok_handler(self)

class Install(InstallPlugin):
    def install(self, target, progress, *args, **kwargs):
        progress.info('tcpd/paranoid-mode') # not really appropriate, but just an example
        cmd = 'touch' if self.db.get('tcpd/paranoid-mode') else 'rm'
        rv = os.system('%s %s' % (cmd, os.path.join(target, '/etc/bar')))
        import time
        time.sleep(45) # just to give you time to see this in the progress bar
        if rv:
            return rv
        return InstallPlugin.install(target, progress, *args, **kwargs)

Ubiquity/Plugins (last edited 2013-01-16 10:57:22 by fourdollars)