/usr/share/pyshared/MythbuntuControlCentre/plugin.py is in mythbuntu-control-centre 0.63-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 | ## -*- coding: utf-8 -*-
#
# «plugin» - The parent level class that all MCC plugins inherit from
#
# Copyright (C) 2009, Mario Limonciello, for Mythbuntu
#
#
# Mythbuntu is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 2 of the License, or at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this application; if not, write to the Free Software Foundation, Inc., 51
# Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
##################################################################################
import logging
import sys
import os
import string
import traceback
#GUI Support
import gtk
#Translation Support
from gettext import gettext as _
class MCCPluginLoader():
"""A class used for initializing all loadable plugins"""
def __init__(self,plugin_root_path):
self._instances = {}
self.plugin_root_path = plugin_root_path
self.plugin_path = plugin_root_path + '/python'
if self.plugin_path not in sys.path:
sys.path.insert(0, self.plugin_path)
def reload_plugins(self):
"""Searches the path for all plugins asked for"""
plugins=[]
for object in os.listdir(self.plugin_path):
if '.py' in object and '.pyc' not in object:
plugins.append(string.split(object,'.py')[0])
for plugin in plugins:
logging.debug(_("Importing plugin") + ": \t" + plugin)
try:
__import__(plugin, None, None, [''])
except:
logging.warning( _("Error importing plugin ") + plugin)
traceback.print_exc()
continue
def find_plugin_classes(self):
"""Returns currently loaded plugin class types"""
logging.debug(_("Found the following plugin classes:"))
logging.debug(MCCPlugin.__subclasses__())
return MCCPlugin.__subclasses__()
def find_plugin_instances(self):
"""Returns all current instances of plugins"""
result = []
for plugin in self.find_plugin_classes():
if not plugin in self._instances:
try:
self._instances[plugin] = plugin()
self._instances[plugin]._set_root_path(self.plugin_root_path)
except:
logging.warning( _("Error loading plugin ") + str(plugin))
traceback.print_exc()
continue
result.append(self._instances[plugin])
logging.debug(_("Found the following plugin instances:"))
logging.debug(result)
return result
class MCCPlugin(object):
"""An abstract class that defines what all plugins need to be able to do"""
def __init__(self,information):
"""Initializes a parent MCC plugin. Information is expected to be a dictionary containing
these keys at a minimum:
name: Name of the plugin
icon: Icon shown for the plugin
And one of these:
ui: UI file used for the plugin"""
if not information.has_key("name") or \
not information.has_key("icon") or \
not information.has_key("ui"):
self._abstract("__init__: information keys")
self._information = information
self._incomplete = False
self.clearParentState()
###Helper functions###
def _set_root_path(self,plugin_root_path):
"""Sets the path to load ui from"""
self.plugin_root_path = plugin_root_path
def _mark_array(self,array,item,value,action):
"""Internal helper function for modifying arrays"""
if action:
if type(array) is dict:
array[item]=value
else:
array.append(item)
else:
if type(array) is dict:
array.pop(item)
else:
for tmp in array:
if tmp == item:
array.remove(item)
return
def _abstract(self, method):
"""Common error that gets raised if a plugin does not redefine
a method that is supposed to be"""
raise NotImplementedError("%s.%s does not implement %s" %
(self.__class__.__module__,
self.__class__.__name__, method))
def updateCache(self,cache):
"""Updates the apt package cache"""
self.pkg_cache=cache
def getInformation(self,key=None):
"""Returns a standard information key"""
if key is None:
return self._information
elif key is 'module':
return self.__class__.__module__
else:
return self._information[key]
def query_installed(self,package):
"""Determines if a single package is installed"""
try:
result = self.pkg_cache[package].current_ver
if result == None:
return False
else:
return True
except KeyError:
return False
def getIncomplete(self):
"""Returns whether a plugin has been fully filled out"""
return self._incomplete
def launch_app(self,widget,data=None):
"""Launches an external application"""
if widget is not None and data is not None:
parent=widget.get_parent_window().get_toplevel()
parent.hide()
while gtk.events_pending():
gtk.main_iteration()
os.system(data)
parent.show()
else:
self._abstract("launch_app")
def insert_extra_widgets(self):
"""Litters the namespace with extra widgets if they exist.
Generally these would be around for things like popup
windows that are plugin specific"""
ui_file = os.path.join(self.plugin_root_path, 'ui', self._information["ui"] + ".extra.ui")
if os.path.exists(ui_file):
logging.debug("Reading UI file: %s" % ui_file)
self.builder.add_from_file(ui_file)
def insert_subpage(self,notebook,buttonbox,handler):
"""Inserts a subtab into the notebook. This assumes the file
shares the same base name as the page you are looking for.
Returns tuple: (name,tab) where tab is the numeric index of the
tab in the GtkNoteBook"""
# Button for the notebook widget
label=gtk.Label(self._information["name"])
icon=gtk.Image()
icon.set_from_icon_name(self._information["icon"],3)
button=gtk.Button()
button.set_alignment(0,0)
button.set_relief(gtk.RELIEF_NONE)
button.set_focus_on_click(True)
hbox=gtk.HBox(spacing=2)
hbox.pack_start(icon,False,False)
hbox.pack_start(label,False,False)
button.add(hbox)
buttonbox.add(button)
button.connect("clicked",handler)
label.show()
icon.show()
hbox.show()
button.show()
# See http://faq.pygtk.org/index.py?req=show&file=faq22.002.htp
# for internationalisation support
widget = None
self.builder = gtk.Builder()
ui_file = os.path.join(self.plugin_root_path,'ui',self._information["ui"] + ".ui")
logging.debug("Reading .ui file: %s" % ui_file)
self.builder.add_from_file(ui_file)
self.builder.connect_signals(self)
for widget in self.builder.get_objects():
if not isinstance(widget, gtk.Widget):
continue
widget.set_name(gtk.Buildable.get_name(widget))
setattr(self, widget.get_name(), widget)
#widget that we will append in the notebook
widget = self.builder.get_object(self._information["ui"])
logging.debug("Appending Widget: %s" % widget.get_name())
notebook.append_page(widget)
return (self._information["name"],notebook.page_num(widget))
###State machine of the plugin###
def clearParentState(self):
"""Clears the state of the elements that were stored for between
runs"""
self._to_install = []
self._to_remove = []
self._to_reconfigure_root = {}
self._to_reconfigure_user = {}
self._request_update = False
self._request_unauth = False
def captureState(self):
"""Determines the state of the items on managed by this plugin
and stores it into the plugin's own internal structures"""
self._abstract("captureState")
def compareState(self):
"""Determines what items have been modified on this plugin"""
self._abstract("compareState")
def applyStateToGUI(self):
"""Takes the current state information and sets the GUI
for this plugin"""
self._abstract("applyStateToGUI")
###Interfacing functions###
def _markInstall(self,item,install=True):
"""Modifies the mark of an item to be installed"""
self._mark_array(self._to_install,item,None,install)
def _markRemove(self,item,remove=True):
"""Modifies the mark of an item to be removed"""
self._mark_array(self._to_remove,item,None,remove)
def _markUnauthenticatedPackages(self,unauth=True):
"""Toggles the bit to request an unauthenticated package to be installed"""
self._request_unauth = unauth
def _markUpdatePackageList(self,update=True):
"""Toggles the bit that requests a package list update at the end"""
self._request_update = update
def _markReconfigureRoot(self,item,value,reconfigure=True):
"""Modifies the mark of an item to be removed"""
self._mark_array(self._to_reconfigure_root,item,value,reconfigure)
def _markReconfigureUser(self,item,value,reconfigure=True):
"""Modifies the mark of an item to be removed"""
self._mark_array(self._to_reconfigure_user,item,value,reconfigure)
def getRawChanges(self):
"""Returns a tupple of raw arrays that can be assembled together"""
return (self._to_install,self._to_remove,self._to_reconfigure_root, self._to_reconfigure_user,self._request_update,self._request_unauth)
def summarizeChanges(self):
"""Returns a pretty summary of all management activities that will occur"""
def summarizeDictionary(array,action):
"""Returns a summary of what's happening in array"""
text=''
if len(array) > 0:
text+=action + " the following items:\n"
text+='\t'
for item in array:
text += item + ' '
text+='\n'
return text
summary=summarizeDictionary(self._to_install,"Install") + \
summarizeDictionary(self._to_remove, "Remove") + \
summarizeDictionary(self._to_reconfigure_root, "Reconfigure (as root)") + \
summarizeDictionary(self._to_reconfigure_user, "Reconfigure (as user)")
if self._request_update:
summary = summary + "Request Package List Update\n"
if self._request_unauth:
summary = summary + "*** WARNING ***\n Unauthenticated Packages Will be Installed during this transaction.\n *** WARNING ***\n"
if summary == '':
summary=False
return summary
###Non package-able changes###
def emit_progress(self, string, pct):
"""Emits a progress event through the backend over dbus"""
def root_scripted_changes(self,reconfigure):
"""System-wide changes that need root access to be applied.
This function is ran by the dbus backend"""
self._abstract("root_scripted_changes")
def user_scripted_changes(self,reconfigure):
"""Local changes that can be performed by the user account.
This function will be ran by the frontend."""
self._abstract("user_scripted_changes")
|