-
Notifications
You must be signed in to change notification settings - Fork 2
/
check-plugin.py
executable file
·314 lines (254 loc) · 9.71 KB
/
check-plugin.py
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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# (c) Copyright 2011-2014 Hewlett-Packard Development Company, L.P.
#
# This program 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 program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Author: Suma Byrappa, Amarnath Chitumalla
#
#
__version__ = '1.1'
__title__ = 'AutoConfig Utility for Plug-in Installation'
__mod__ = 'hp-check-plugin'
__doc__ = "Auto config utility for HPLIP supported multifunction Devices for installing proprietary plug-ins."
# Std Lib
import sys
import os
import os.path
import getopt
import signal
import operator
import time
# Local
from base.g import *
from base import utils, device, tui, module, pkit, services
from installer import pluginhandler
# Temp values for testing; May not be needed
username = ""
device_uri = ""
printer_name = ""
LOG_FILE = "%s/hplip_ac.log"%prop.user_dir
DBUS_SERVICE='com.hplip.StatusService'
##### METHODS #####
# Send dbus event to hpssd on dbus system bus
def send_message(device_uri, printer_name, event_code, username, job_id, title, pipe_name=''):
log.debug("send_message() entered")
args = [device_uri, printer_name, event_code, username, job_id, title, pipe_name]
msg = lowlevel.SignalMessage('/', DBUS_SERVICE, 'Event')
msg.append(signature='ssisiss', *args)
SystemBus().send_message(msg)
log.debug("send_message() returning")
# Plugin installation
def install_Plugin(systray_running_status, run_directly=False):
if run_directly:
if not utils.canEnterGUIMode4():
log.error("%s requires GUI support . Is Qt4 installed?" % __mod__)
sys.exit(1)
try:
from PyQt4.QtGui import QApplication, QMessageBox
from ui4.plugindiagnose import PluginDiagnose
from installer import core_install
except ImportError:
log.error("Unable to load Qt4 support. Is it installed?")
sys.exit(1)
app = QApplication(sys.argv)
plugin = PLUGIN_REQUIRED
plugin_reason = PLUGIN_REASON_NONE
ok, sudo_ok = pkit.run_plugin_command(plugin == PLUGIN_REQUIRED, plugin_reason)
if not ok or not sudo_ok:
log.error("Failed to install plug-in.")
elif systray_running_status:
send_message( device_uri, "", EVENT_AUTO_CONFIGURE, username, 0, "AutoConfig")
log.debug("Event EVENT_AUTO_CONFIGURE sent to hp-systray to invoke hp-plugin")
else:
log.error("Run hp-systray manually and re-plugin printer")
#TBD: needs to run hp-plugin in silent mode. or needs to show error UI to user.
#Installs/Uploads the firmware to device once plugin installation is completed.
def install_firmware(pluginObj,Plugin_Installation_Completed, USB_param):
#timeout check for plugin installation
sleep_timeout = 6000 # 10 mins time out
while Plugin_Installation_Completed is False and sleep_timeout != 0:
time.sleep(0.3) #0.3 sec delay
sleep_timeout = sleep_timeout -3
ps_plugin,output = utils.Is_Process_Running('hp-plugin')
ps_diagnose_plugin,output = utils.Is_Process_Running('hp-diagnose_plugin')
if ps_plugin is False and ps_diagnose_plugin is False:
Plugin_Installation_Completed = True
if pluginObj.getStatus() == PLUGIN_INSTALLED:
break
else:
log.error("Failed to download firmware required files. manually run hp-plugin command in terminal fisrt")
sys.exit(1)
execmd="hp-firmware"
options=""
if USB_param is not None:
options += " -y3 %s"%(USB_param)
if log_level is 'debug':
options += " -g"
cmd= execmd + options
log.info("Starting Firmware installation.")
log.debug("Running command : %s " %cmd)
Status, out=utils.run(cmd)
# if Status == 0:
# log.info("Installed firmware ")
# else:
# log.error("Failed to install firmware = %s" %Status)
#Usage details
USAGE = [(__doc__, "", "name", True),
("Usage: %s [OPTIONS] [USB bus:device]" % __mod__, "", "summary", True),
utils.USAGE_OPTIONS,
("Install Plug-in through HP System Tray:", "-m (Default)", "option", False),
("Install Plug-in through hp-plugin:", "-p", "option", False),
("Download firmware into the device:", "-f", "option", False),
utils.USAGE_HELP,
utils.USAGE_LOGGING1, utils.USAGE_LOGGING2, utils.USAGE_LOGGING3,
utils.USAGE_EXAMPLES,
("Install plugin:", "$%s 001:002"%(__mod__), "example", False),
("Install plugin and firmware:", "$%s -f 001:002"%(__mod__), "example", False),
utils.USAGE_NOTES,
("-m and -p options can't be used together. ","","note",False),
]
def usage(typ='text'):
if typ == 'text':
utils.log_title(__title__, __version__)
utils.format_text(USAGE, typ, __title__, __mod__, __version__)
sys.exit(0)
##### MAIN #####
try:
import dbus
from dbus import SystemBus, lowlevel
except ImportError:
log.error("hp-check-plugin Tool requires dBus and python-dbus")
sys.exit(1)
try:
mod = module.Module(__mod__, __title__, __version__, __doc__, USAGE, (INTERACTIVE_MODE, GUI_MODE), (UI_TOOLKIT_QT3, UI_TOOLKIT_QT4), run_as_root_ok=True, quiet=True)
opts, device_uri, printer_name, mode, ui_toolkit, loc = \
mod.parseStdOpts('l:hHuUmMfFpPgG',['gui','help', 'help-rest', 'help-man', 'help-desc','logging='],handle_device_printer=False)
except getopt.GetoptError, e:
log.error(e.msg)
usage()
sys.exit(1)
if os.getenv("HPLIP_DEBUG"):
log.set_level('debug')
log_level = 'info'
Systray_Msg_Enabled = False
Plugin_option_Enabled = False
Firmware_Option_Enabled = False
GUI_Mode = True
Is_Plugin_Already_Installed = False
for o, a in opts:
if o in ('-h','-H', '--help'):
usage()
elif o == '--help-rest':
usage('rest')
elif o == '--help-man':
usage('man')
elif o in ('-u', '-U','--gui'):
# currenlty only GUI mode is supported. hence not reading this option
GUI_Mode = True
# elif o in ('-i', '-I', '--interactive'):
# #this is future use
# GUI_Mode = False
elif o == '--help-desc':
print __doc__,
sys.exit(0)
elif o in ('-l', '--logging'):
log_level = a.lower().strip()
elif o in('-g', '-G'):
log_level = 'debug'
elif o in ('-m', '-M'):
Systray_Msg_Enabled = True
elif o in ('-p', '-P'):
Plugin_option_Enabled = True
elif o in ('-F','-f'):
Firmware_Option_Enabled = True
if not log.set_level (log_level):
usage()
try:
param = mod.args[0]
except IndexError:
param = ''
LOG_FILE = os.path.normpath(LOG_FILE)
log.info(log.bold("Saving output in log file: %s" % LOG_FILE))
if os.path.exists(LOG_FILE):
try:
os.remove(LOG_FILE)
except OSError:
pass
log.set_logfile(LOG_FILE)
log.set_where(log.LOG_TO_CONSOLE_AND_FILE)
log.debug(" hp-check-plugin started")
if Plugin_option_Enabled and Systray_Msg_Enabled:
log.error("Both -m and -p options can't be used together.")
usage()
sys.exit(1)
log.debug("param=%s" % param)
if len(param) < 1:
usage()
sys.exit()
if param:
device_uri, sane_uri, fax_uri = device.makeURI(param)
if not device_uri:
log.error("This is not a valid device")
sys.exit(0)
log.debug("\nSetting up device: %s\n" % device_uri)
#Query model and checks Plugin information.
mq = device.queryModelByURI(device_uri)
if not mq or mq.get('support-type', SUPPORT_TYPE_NONE) == SUPPORT_TYPE_NONE:
log.error("Unsupported printer model.")
sys.exit(1)
plugin = mq.get('plugin', PLUGIN_NONE)
if plugin == PLUGIN_NONE:
log.debug("This is not a plugin device.")
sys.exit()
if not Plugin_option_Enabled:
Systray_Msg_Enabled = True
# checking whether HP-systray is running or not. Invokes, if systray is not running
Systray_Is_Running=False
status,output = utils.Is_Process_Running('hp-systray')
if status is False:
if os.getuid() == 0:
log.error(" hp-systray must be running.\n Run \'hp-systray &\' in a terminal. ")
else:
log.info("Starting hp-systray service")
services.run_systray()
status,output = utils.Is_Process_Running('hp-systray')
if status == True:
Systray_Is_Running=True
log.debug("hp-systray service is running\n")
pluginObj = pluginhandler.PluginHandle()
plugin_sts = pluginObj.getStatus()
if plugin_sts == pluginhandler.PLUGIN_INSTALLED:
log.info("Device Plugin is already installed")
Is_Plugin_Already_Installed = True
elif plugin_sts == pluginhandler.PLUGIN_NOT_INSTALLED :
log.info("HP Device Plug-in is not found")
else:
log.info("HP Device Plug-in version mismatch or some files are corrupted")
if Systray_Msg_Enabled:
if not Is_Plugin_Already_Installed:
install_Plugin( Systray_Is_Running)
elif Plugin_option_Enabled:
if not Is_Plugin_Already_Installed:
install_Plugin (Systray_Is_Running, True) # needs to run hp-plugin without usig systray
if Firmware_Option_Enabled:
if Is_Plugin_Already_Installed is False:
Plugin_Installation_Completed = False
else:
Plugin_Installation_Completed = True
install_firmware(pluginObj, Plugin_Installation_Completed, param)
log.info()
log.info("Done.")