wcs/wcs/admin/workflows.py

1930 lines
79 KiB
Python

# -*- coding: utf-8 -*-
#
# w.c.s. - web application for online forms
# Copyright (C) 2005-2010 Entr'ouvert
#
# 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, see <http://www.gnu.org/licenses/>.
import time
from subprocess import Popen, PIPE
import textwrap
import xml.etree.ElementTree as ET
from django.utils.six import StringIO
from quixote import redirect, get_publisher
from quixote.directory import Directory
from quixote.html import TemplateIO, htmltext
from qommon import _
from qommon import errors
from qommon import misc
from qommon.form import *
from qommon.backoffice.menu import html_top
from qommon.admin.menu import command_icon
from qommon import get_logger
from wcs.workflows import *
from wcs.formdef import FormDef
from wcs.formdata import Evolution
from .fields import FieldDefPage, FieldsDirectory
from .data_sources import NamedDataSourcesDirectory
from .logged_errors import LoggedErrorsDirectory
def svg(tag):
return '{http://www.w3.org/2000/svg}%s' % tag
def xlink(tag):
return '{http://www.w3.org/1999/xlink}%s' % tag
TITLE = svg('title')
POLYGON = svg('polygon')
XLINK_TITLE = xlink('title')
def remove_tag(node, tag):
for child in node:
if child.tag == tag:
node.remove(child)
def remove_attribute(node, att):
if att in node.attrib:
del node.attrib[att]
def remove_style(node, top, colours, white_text=False):
remove_tag(node, TITLE)
if (node.get('fill'), node.get('stroke')) in (
('white', 'white'), ('white', 'none')):
# this is the general white background, reduce it to a dot
node.attrib['points'] = '0,0 0,0 0,0 0,0'
if node.tag == svg('text') and white_text:
node.attrib['fill'] = 'white'
for child in node:
remove_attribute(child, XLINK_TITLE)
if child.get('fill') in colours:
matching_hexa = colours.get(child.get('fill'))
child.attrib['fill'] = '#' + matching_hexa
del child.attrib['stroke']
if misc.get_foreground_colour(matching_hexa) == 'white':
white_text = True
if child.get('font-family'):
del child.attrib['font-family']
if child.get('font-size'):
child.attrib['font-size'] = str(float(child.attrib['font-size'])*0.8)
remove_attribute(child, 'style')
remove_style(child, top, colours, white_text=white_text)
def graphviz_post_treatment(content, colours, include=False):
''' Remove all svg:title and top-level svg:polygon nodes, remove style
attributes and xlink:title attributes.
If a color style is set to a name matching class-\w+, set the second
part on as class selector on the top level svg:g element.
'''
tree = ET.fromstring(content)
if not include:
style = ET.SubElement(tree, svg('style'))
style.attrib['type'] = 'text/css'
css_url = '%s%s%s' % (get_publisher().get_root_url(),
get_publisher().qommon_static_dir,
get_publisher().qommon_admin_css)
style.text = '@import url(%s);' % css_url
for root in tree:
remove_tag(root, TITLE)
# remove_tag(root, POLYGON)
for child in root:
remove_style(child, child, colours)
return ET.tostring(tree)
def graphviz(workflow, url_prefix='', select=None, svg=True,
include=False):
out = StringIO()
# a list of colours known to graphviz, they will serve as key to get back
# to the colours defined in wcs.
graphviz_colours = [
'aliceblue', 'antiquewhite', 'aqua', 'aquamarine', 'azure', 'beige',
'bisque', 'black', 'blanchedalmond', 'blue', 'blueviolet', 'brown',
'burlywood', 'cadetblue', 'chartreuse', 'chocolate', 'coral',
'cornflowerblue', 'cornsilk', 'crimson', 'cyan', 'darkblue',
'darkcyan', 'darkgoldenrod', 'darkgray', 'darkgreen', 'darkgrey',
'darkkhaki', 'darkmagenta', 'darkolivegreen', 'darkorange',
'darkorchid', 'darkred', 'darksalmon', 'darkseagreen', 'darkslateblue',
'darkslategray', 'darkslategrey', 'darkturquoise', 'darkviolet',
'deeppink', 'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue',
'firebrick', 'floralwhite', 'forestgreen', 'fuchsia', 'gainsboro',
'ghostwhite', 'gold', 'goldenrod', 'gray', 'grey', 'green',
'greenyellow', 'honeydew', 'hotpink', 'indianred', 'indigo', 'ivory',
'khaki', 'lavender', 'lavenderblush', 'lawngreen', 'lemonchiffon',
'lightblue', 'lightcoral', 'lightcyan', 'lightgoldenrodyellow',
'lightgray', 'lightgreen', 'lightgrey', 'lightpink', ]
colours = {}
revert_colours = {}
print >>out, 'digraph main {'
# print >>out, 'graph [ rankdir=LR ];'
print >>out, 'node [shape=box,style=filled];'
print >>out, 'edge [];'
for status in workflow.possible_status:
i = status.id
print >>out, 'status%s' % i,
print >>out, '[label="%s"' % status.name.replace('"', "'"),
if select == str(i):
print >>out, ',id=current_status'
if status.colour:
if status.colour not in colours:
colours[status.colour] = graphviz_colours.pop()
revert_colours[colours[status.colour]] = status.colour
print >>out, ',color=%s' % colours[status.colour]
print >>out, ' URL="%sstatus/%s/"];' % (url_prefix, i)
for status in workflow.possible_status:
i = status.id
for item in status.items:
next_status_ids = [x.id for x in item.get_target_status() if x.id]
if not next_status_ids:
next_status_ids = [status.id]
done = {}
url = 'status/%s/items/%s/' % (i, item.id)
for next_id in next_status_ids:
if next_id in done:
# don't display multiple arrows for same action and target
# status
continue
print >>out, 'status%s -> status%s' % (i, next_id)
done[next_id] = True
label = item.get_jump_label(target_id=next_id)
label = label.replace('"', '\\"')
label = label.decode('utf8')
label = textwrap.fill(label, 20, break_long_words=False)
label = label.encode('utf8')
label = label.replace('\n', '\\n')
print >>out, '[label="%s"' % label,
print >>out, ',URL="%s%s"]' % (url_prefix, url)
print >>out, '}'
out = out.getvalue()
if svg:
try:
process = Popen(['dot', '-Tsvg'], stdin=PIPE, stdout=PIPE)
out, err = process.communicate(out)
if process.returncode != 0:
return ''
except OSError:
return ''
out = graphviz_post_treatment(out, revert_colours, include=include)
if include:
# It seems webkit refuse to accept SVG when using its proper namespace,
# and xlink namespace prefix must be xlink: to be acceptable
out = out.replace('ns0:', '')
out = out.replace('xmlns:ns0', 'xmlns:svg')
out = out.replace('ns1:', 'xlink:')
out = out.replace(':ns1', ':xlink')
out = out.replace('<title>main</title>', '<title>%s</title>' % workflow.name)
return out
class WorkflowUI(object):
def __init__(self, workflow):
self.workflow = workflow
def form_new(self):
form = Form(enctype='multipart/form-data')
form.add(StringWidget, 'name', title = _('Workflow Name'), required = True, size=30)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
return form
def form_edit(self):
form = Form(enctype='multipart/form-data')
form.add_hidden('id', value = self.workflow.id)
form.add(StringWidget, 'name', title = _('Workflow Name'), required = True, size=30,
value = self.workflow.name)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
return form
def submit_form(self, form):
if self.workflow:
workflow = self.workflow
else:
workflow = Workflow(name = form.get_widget('name').parse())
name = form.get_widget('name').parse()
workflows_name = [x.name for x in Workflow.select() if x.id != workflow.id]
if name in workflows_name:
form.get_widget('name').set_error(_('This name is already used'))
raise ValueError()
for f in ('name',):
setattr(workflow, f, form.get_widget(f).parse())
workflow.store()
return workflow
class WorkflowItemPage(Directory):
_q_exports = ['', 'delete']
def __init__(self, workflow, parent, component, html_top):
try:
self.item = [x for x in parent.items if x.id == component][0]
except (IndexError, ValueError):
raise errors.TraversalError()
self.workflow = workflow
self.parent = parent
self.html_top = html_top
get_response().breadcrumb.append(('items/%s/' % component, _(self.item.description)))
def _q_index(self):
request = get_request()
if request.get_method() == 'GET' and request.form.get('file'):
value = getattr(self.item, request.form.get('file'), None)
if value:
return value.build_response()
form = Form(enctype='multipart/form-data')
self.item.fill_admin_form(form)
if not str(self.workflow.id).startswith(str('_')):
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('..')
if not form.get_submit() == 'submit' or form.has_errors():
self.html_top('%s - %s' % (_('Workflow'), self.workflow.name))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _(self.item.description)
r += form.render()
if self.item.support_substitution_variables:
r += htmltext('<h3>%s</h3>') % _('Variables')
r += get_publisher().substitutions.get_substitution_html_table()
return r.getvalue()
else:
self.item.submit_admin_form(form)
self.workflow.store()
return redirect('..')
def delete(self):
form = Form(enctype='multipart/form-data')
form.widgets.append(HtmlWidget('<p>%s</p>' % _('You are about to remove an item.')))
form.add_submit('delete', _('Delete'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('../../')
if not form.is_submitted() or form.has_errors():
get_response().breadcrumb.append(('delete', _('Delete')))
self.html_top(title = _('Delete Item'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('Deleting Item')
r += form.render()
return r.getvalue()
else:
del self.parent.items[self.parent.items.index(self.item)]
self.workflow.store()
return redirect('../../')
def _q_lookup(self, component):
t = self.item.q_admin_lookup(self.workflow, self.parent, component,
self.html_top)
if t:
return t
return Directory._q_lookup(self, component)
class GlobalActionTriggerPage(Directory):
_q_exports = ['', 'delete']
def __init__(self, workflow, action, component, html_top):
try:
self.trigger = [x for x in action.triggers if x.id == component][0]
except (IndexError, ValueError):
raise errors.TraversalError()
self.workflow = workflow
self.action = action
self.status = action
self.html_top = html_top
get_response().breadcrumb.append(('triggers/%s/' % component, _('Trigger')))
def _q_index(self):
form = self.trigger.form(self.workflow)
form.add_submit('submit', _('Save'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('..')
if form.get_submit() == 'submit' and not form.has_errors():
self.trigger.submit_admin_form(form)
if not form.has_errors():
self.workflow.store()
return redirect('../../')
self.html_top('%s - %s' % (_('Workflow'), self.workflow.name))
r = TemplateIO(html=True)
r += htmltext('<h2>%s - %s</h2>') % (self.workflow.name, self.action.name)
r += form.render()
return r.getvalue()
def delete(self):
form = Form(enctype='multipart/form-data')
form.widgets.append(HtmlWidget('<p>%s</p>' % _('You are about to remove a trigger.')))
form.add_submit('delete', _('Delete'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('../../')
if not form.is_submitted() or form.has_errors():
get_response().breadcrumb.append(('delete', _('Delete')))
self.html_top(title=_('Delete Trigger'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('Deleting Trigger')
r += form.render()
return r.getvalue()
else:
del self.action.triggers[self.action.triggers.index(self.trigger)]
self.workflow.store()
return redirect('../../')
class ToChildDirectory(Directory):
_q_exports = ['']
klass = None
def __init__(self, workflow, status, html_top):
self.workflow = workflow
self.status = status
self.html_top = html_top
def _q_lookup(self, component):
return self.klass(self.workflow, self.status, component, self.html_top)
def _q_index(self):
return redirect('..')
class WorkflowItemsDir(ToChildDirectory):
klass = WorkflowItemPage
class GlobalActionTriggersDir(ToChildDirectory):
klass = GlobalActionTriggerPage
class GlobalActionItemsDir(ToChildDirectory):
klass = WorkflowItemPage
class WorkflowStatusPage(Directory):
_q_exports = ['', 'delete', 'newitem', ('items', 'items_dir'),
'update_order', 'edit', 'reassign',
'endpoint', 'display',
('backoffice-info-text', 'backoffice_info_text'),]
def __init__(self, workflow, status_id, html_top):
self.html_top = html_top
self.workflow = workflow
try:
self.status = [x for x in self.workflow.possible_status if x.id == status_id][0]
except IndexError:
raise errors.TraversalError()
self.items_dir = WorkflowItemsDir(workflow, self.status, html_top)
get_response().breadcrumb.append(('status/%s/' % status_id, self.status.name))
def _q_index(self):
self.html_top('%s - %s' % (_('Workflow'), self.workflow.name))
r = TemplateIO(html=True)
get_response().add_javascript(['jquery.js', 'jquery-ui.js', 'biglist.js', 'svg-pan-zoom.js',
'qommon.wysiwyg.js'])
get_response().add_javascript_code('$(function () { svgPanZoom("svg", {controlIconsEnabled: true}); });')
r += htmltext('<h2>%s</h2>') % self.status.name
r += get_session().display_message()
if self.status.get_visibility_restricted_roles():
r += htmltext('<div class="bo-block">')
r += _('This status is hidden from the user.')
if not str(self.workflow.id).startswith(str('_')):
r += ' '
r += htmltext('(<a href="display" rel="popup">%s</a>)') % _('change')
r += htmltext('</div>')
if not self.status.items:
r += htmltext('<div class="infonotice">%s</div>') % _('There are not yet any items in this status.')
else:
r += htmltext('<div class="bo-block">')
if str(self.workflow.id).startswith(str('_')):
r += htmltext('<ul id="items-list" class="biglist">')
else:
r += htmltext('<p class="hint">')
r += _('Use drag and drop with the handles to reorder items.')
r += htmltext('</p>')
r += htmltext('<ul id="items-list" class="biglist sortable">')
for i, item in enumerate(self.status.items):
r += htmltext('<li class="biglistitem" id="itemId_%s">') % item.id
if str(self.workflow.id).startswith(str('_')):
r += item.render_as_line()
else:
if hasattr(item, str('fill_admin_form')):
r += htmltext('<a href="items/%s/">%s</a>') % (item.id, item.render_as_line())
else:
r += item.render_as_line()
r += htmltext('<p class="commands">')
if hasattr(item, str('fill_admin_form')):
r += command_icon('items/%s/' % item.id, 'edit')
r += command_icon('items/%s/delete' % item.id, 'remove', popup = True)
r += htmltext('</p>')
r += htmltext('</li>')
r += htmltext('</ul>')
r += htmltext('</div>') # bo-block
source_status = []
for status in self.workflow.possible_status:
if status is self.status:
continue
for item in status.items:
if self.status in item.get_target_status():
source_status.append(status)
break
if source_status:
r += htmltext('<div class="bo-block">')
r += htmltext('<h3>%s</h3>') % _('Jumps')
r += htmltext('<p>%s ') % _('This status is reachable from the following status:')
r += htmltext(', ').join([htmltext('<a href="../%s/">%s</a>') % (x.id, x.name) for x in source_status])
r += htmltext('.</p>')
r += htmltext('</div>')
r += htmltext('<p><a href="../../">%s</a></p>') % _('Back to workflow main page')
r += htmltext('<div class="bo-block">')
r += htmltext(graphviz(self.workflow, url_prefix='../../', include=True,
select='%s' % self.status.id))
r += htmltext('</div>')
get_response().filter['sidebar'] = self.get_sidebar()
return r.getvalue()
def get_sidebar(self):
get_response().add_javascript(['jquery.js', 'jquery-ui.js', 'popup.js',
'jquery.colourpicker.js'])
r = TemplateIO(html=True)
if str(self.workflow.id).startswith(str('_')):
r += htmltext('<p>')
r += _('''This is the default workflow, you cannot edit it but you can
duplicate it to base your own workflow on it.''')
r += htmltext('</p>')
else:
r += htmltext('<ul id="sidebar-actions">')
r += htmltext('<li><a href="edit" rel="popup">%s</a></li>') % _('Change Status Name')
r += htmltext('<li><a href="display" rel="popup">%s</a></li>') % _('Change Display Settings')
r += htmltext('<li><a href="endpoint" rel="popup">%s</a></li>') % _('Change Terminal Status')
r += htmltext('<li><a href="backoffice-info-text" rel="popup">%s</a></li>'
) % _('Change Backoffice Information Text')
r += htmltext('<li><a href="delete" rel="popup">%s</a></li>') % _('Delete')
r += htmltext('</ul>')
r += htmltext('<div id="new-field">')
r += htmltext('<h3>%s</h3>') % _('New Action')
r += self.get_new_item_form().render()
r += htmltext('</div>')
return r.getvalue()
def is_item_available(self, item):
return item.is_available(workflow=self.workflow)
def get_new_item_form(self):
form = Form(enctype='multipart/form-data', action='newitem',
id='new-action-form')
categories = [
('status-change', _('Change Status')),
('interaction', _('Interact')),
('formdata-action', _('Act on Form')),
('user-action', _('Act on User')),
]
available_items = [x for x in item_classes if self.is_item_available(x)]
available_items.sort(key=lambda x: misc.simplify(_(x.description)))
for category, category_label in categories:
options = [(x.key, _(x.description)) for x in available_items
if x.category == category]
form.add(SingleSelectWidget, 'action-%s' % category, title=category_label,
required=False, options=[(None, '')] + options)
form.add_submit('submit', _('Add'))
return form
def update_order(self):
request = get_request()
new_order = request.form['order'].strip(';').split(';')
self.status.items = [ [x for x in self.status.items if x.id == y][0] for y in new_order]
self.workflow.store()
return 'ok'
def newitem(self):
form = self.get_new_item_form()
if not form.is_submitted() or form.has_errors():
get_session().message = ('error', _('Submitted form was not filled properly.'))
return redirect('.')
for category in ('status-change', 'interaction', 'formdata-action', 'user-action'):
action_type = form.get_widget('action-%s' % category).parse()
if action_type:
self.status.append_item(action_type)
self.workflow.store()
return redirect('.')
get_session().message = ('error', _('Submitted form was not filled properly.'))
return redirect('.')
def delete(self):
form = Form(enctype="multipart/form-data")
form.widgets.append(HtmlWidget('<p>%s</p>' % _(
"You are about to remove a status.")))
form.add_submit('delete', _('Delete'))
form.add_submit("cancel", _("Cancel"))
if form.get_widget('cancel').parse():
return redirect('.')
if not form.is_submitted() or form.has_errors():
get_response().breadcrumb.append(('delete', _('Delete')))
self.html_top(title = _('Delete Status'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s %s</h2>') % (_('Deleting Status:'), self.status.name)
r += form.render()
return r.getvalue()
else:
# Before removing the status, scan formdata to know if it's in use.
for formdef in FormDef.select():
if formdef.workflow_id != self.workflow.id:
continue
if any(formdef.data_class().get_with_indexed_value(
str('status'), 'wf-%s' % self.status.id)):
return redirect('reassign')
del self.workflow.possible_status[ self.workflow.possible_status.index(self.status) ]
self.workflow.store()
return redirect('../../')
def edit(self):
form = Form(enctype = 'multipart/form-data')
form.add(StringWidget, 'name', title = _('Status Name'), required = True, size=30,
value = self.status.name)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('.')
if form.is_submitted() and not form.has_errors():
new_name = str(form.get_widget('name').parse())
if [x for x in self.workflow.possible_status if x.name == new_name]:
form.get_widget('name').set_error(
_('There is already a status with that name.'))
else:
self.status.name = new_name
self.workflow.store()
return redirect('.')
self.html_top(title = _('Edit Workflow Status'))
get_response().breadcrumb.append( ('edit', _('Edit')) )
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('Edit Workflow Status')
r += form.render()
return r.getvalue()
def reassign(self):
options = [(None, _('Do nothing')),
('remove', _('Remove these forms'))]
for status in self.workflow.get_waitpoint_status():
if status.id == self.status.id:
continue
options.append(('reassign-%s' % status.id,
_('Change these forms status to "%s"') % status.name))
form = Form(enctype='multipart/form-data')
form.add(SingleSelectWidget, 'action', title=_('Pick an Action'),
options=options)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
if form.get_submit() == 'cancel':
return redirect('.')
if form.is_submitted() and not form.get_widget('action').parse():
return redirect('.')
if not form.is_submitted() or form.has_errors():
get_response().breadcrumb.append(('reassign', _('Delete / Reassign')))
self.html_top(title = _('Delete Status / Reassign'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s %s</h2>') % (_('Deleting Status:'), self.status.name)
r += htmltext('<p>')
r += _('''There are forms set to this status, they need to be changed before
this status can be deleted.''')
r += htmltext('</p>')
r += htmltext('<ul>')
for formdef in FormDef.select():
if formdef.workflow_id != self.workflow.id:
continue
items = list(formdef.data_class().get_with_indexed_value(
str('status'), 'wf-%s' % self.status.id))
r += htmltext('<li>%s: %s</li>') % (formdef.name, _('%s items') % len(items))
r += htmltext('</ul>')
r += form.render()
return r.getvalue()
else:
self.submit_reassign(form)
del self.workflow.possible_status[ self.workflow.possible_status.index(self.status) ]
self.workflow.store()
return redirect('../..')
def submit_reassign(self, form):
nb_forms = 0
action = form.get_widget('action').parse()
if action.startswith(str('reassign-')):
new_status = 'wf-%s' % str(action)[9:]
for formdef in FormDef.select():
if formdef.workflow_id != self.workflow.id:
continue
for item in formdef.data_class().get_with_indexed_value(
str('status'), 'wf-%s' % self.status.id):
nb_forms += 1
if action == 'remove':
item.remove_self()
else:
item.status = new_status
evo = Evolution()
evo.time = time.localtime()
evo.status = new_status
evo.comment = _('Administrator reassigned status')
if not item.evolution:
item.evolution = []
item.evolution.append(evo)
item.store()
# delete all (old) status references in evolutions
for item in formdef.data_class().select():
if item.evolution:
modified = False
for evo in item.evolution:
if evo.status == self.status:
evo.status = None
modified = True
if modified:
item.store()
if action == 'remove':
get_logger().info('admin - delete status "%s" in workflow "%s": %d forms deleted' % (
self.status.name, self.workflow.name, nb_forms))
def display(self):
form = Form(enctype = 'multipart/form-data')
form.add(CheckboxWidget, 'hide_status_from_user',
title=_('Hide status from user'),
value=bool(self.status.get_visibility_restricted_roles()))
form.add(ColourWidget, 'colour',
title=_('Colour in backoffice'),
value=self.status.colour)
form.add(StringWidget, 'extra_css_class',
title=_('Extra CSS for frontoffice style'),
value=self.status.extra_css_class)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('.')
if form.is_submitted() and not form.has_errors():
hide_status = form.get_widget('hide_status_from_user').parse()
if hide_status:
self.status.visibility = self.workflow.roles.keys()
else:
self.status.visibility = None
self.status.colour = form.get_widget('colour').parse() or 'ffffff'
self.status.extra_css_class = form.get_widget('extra_css_class').parse()
self.workflow.store()
return redirect('.')
self.html_top(title = _('Change Display Settings'))
get_response().breadcrumb.append(('display', _('Display Settings')))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('Change Display Settings')
r += form.render()
return r.getvalue()
def endpoint(self):
form = Form(enctype = 'multipart/form-data')
form.add(CheckboxWidget, 'force_terminal_status',
title=_('Force Terminal Status'),
value=(self.status.forced_endpoint is True))
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('.')
if form.is_submitted() and not form.has_errors():
self.status.forced_endpoint = form.get_widget('force_terminal_status').parse()
self.workflow.store()
return redirect('.')
self.html_top(title = _('Edit Terminal Status'))
get_response().breadcrumb.append( ('endpoint', _('Terminal Status')) )
return form.render()
def backoffice_info_text(self):
form = Form(enctype = 'multipart/form-data')
form.add(WysiwygTextWidget, 'backoffice_info_text',
title=_('Information text for backoffice'),
value=self.status.backoffice_info_text)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('.')
if form.is_submitted() and not form.has_errors():
self.status.backoffice_info_text = form.get_widget('backoffice_info_text').parse()
self.workflow.store()
return redirect('.')
self.html_top(title = _('Edit Backoffice Information Text'))
get_response().breadcrumb.append( ('backoffice_info_text',
_('Backoffice Information Text')) )
return form.render()
class WorkflowStatusDirectory(Directory):
_q_exports = ['']
def __init__(self, workflow, html_top):
self.workflow = workflow
self.html_top = html_top
def _q_lookup(self, component):
return WorkflowStatusPage(self.workflow, component, self.html_top)
def _q_index(self):
return redirect('..')
class WorkflowVariableWidget(CompositeWidget):
def __init__(self, name, value=None, workflow=None, **kwargs):
CompositeWidget.__init__(self, name, **kwargs)
if value and '*' in value:
varname = None
else:
varname = value
self.add(VarnameWidget, 'name', render_br=False, value=varname)
options = []
if workflow:
excluded_parameters = ['backoffice_info_text']
for status in workflow.possible_status:
for item in status.items:
prefix = '%s*%s*' % (status.id, item.id)
parameters = [x for x in item.get_parameters() if
not getattr(item, x) and x not in excluded_parameters]
label = getattr(item, 'label', None) or _(item.description)
for parameter in parameters:
key = prefix + parameter
fake_form = Form()
item.add_parameters_widgets(fake_form, [parameter])
if not fake_form.widgets:
continue
parameter_label = fake_form.widgets[0].title
option_value = '%s / %s / %s' % (status.name, label, parameter_label)
options.append((key, option_value, key))
if not options:
return
options = [('', '---', '')] + options
self.widgets.append(HtmlWidget(
_('or you can use this field to directly replace a workflow parameter:')))
self.add(SingleSelectWidget, 'select', options=options,
value=value,
hint=_('This takes priority over a variable name'))
def _parse(self, request):
super(WorkflowVariableWidget, self)._parse(request)
if self.get('select'):
self.value = self.get('select')
elif self.get('name'):
self.value = self.get('name')
class WorkflowVariablesFieldDefPage(FieldDefPage):
section = 'workflows'
blacklisted_attributes = ['condition']
def form(self):
form = super(WorkflowVariablesFieldDefPage, self).form()
form.remove('varname')
form.add(WorkflowVariableWidget, 'varname', title=_('Variable'),
value=self.field.varname, advanced=False, required=True,
workflow=self.objectdef.workflow)
return form
class WorkflowBackofficeFieldDefPage(FieldDefPage):
section = 'workflows'
blacklisted_attributes = ['condition']
def form(self):
form = super(WorkflowBackofficeFieldDefPage, self).form()
form.remove('prefill')
return form
class WorkflowVariablesFieldsDirectory(FieldsDirectory):
_q_exports = ['', 'update_order', 'new']
section = 'workflows'
field_def_page_class = WorkflowVariablesFieldDefPage
support_import = False
blacklisted_types = ['page']
field_var_prefix = 'form_option_'
def index_top(self):
r = TemplateIO(html=True)
r += htmltext('<h2>%s - %s - %s</h2>') % (_('Workflow'),
self.objectdef.name, _('Variables'))
r += get_session().display_message()
if not self.objectdef.fields:
r += htmltext('<p>%s</p>') % _('There are not yet any variables.')
return r.getvalue()
def index_bottom(self):
pass
class WorkflowBackofficeFieldsDirectory(FieldsDirectory):
_q_exports = ['', 'update_order', 'new']
section = 'workflows'
field_def_page_class = WorkflowBackofficeFieldDefPage
support_import = False
blacklisted_types = ['page']
blacklisted_attributes = ['condition']
field_var_prefix = 'form_var_'
def index_top(self):
r = TemplateIO(html=True)
r += htmltext('<h2>%s - %s - %s</h2>') % (_('Workflow'),
self.objectdef.name, _('Backoffice Fields'))
r += get_session().display_message()
if not self.objectdef.fields:
r += htmltext('<p>%s</p>') % _('There are not yet any backoffice fields.')
return r.getvalue()
def index_bottom(self):
pass
class VariablesDirectory(Directory):
_q_exports = ['', 'fields']
def __init__(self, workflow):
self.workflow = workflow
def _q_index(self):
return redirect('fields/')
def _q_traverse(self, path):
get_response().breadcrumb.append(('variables/', _('Variables')))
self.fields = WorkflowVariablesFieldsDirectory(
WorkflowVariablesFieldsFormDef(self.workflow))
return Directory._q_traverse(self, path)
class BackofficeFieldsDirectory(Directory):
_q_exports = ['', 'fields']
def __init__(self, workflow):
self.workflow = workflow
def _q_index(self):
return redirect('fields/')
def _q_traverse(self, path):
get_response().breadcrumb.append(('backoffice-fields/', _('Backoffice Fields')))
self.fields = WorkflowBackofficeFieldsDirectory(
WorkflowBackofficeFieldsFormDef(self.workflow))
return Directory._q_traverse(self, path)
class FunctionsDirectory(Directory):
_q_exports = ['', 'new']
def __init__(self, workflow):
self.workflow = workflow
def _q_traverse(self, path):
get_response().breadcrumb.append(('functions/', _('Functions')))
return Directory._q_traverse(self, path)
def new(self):
form = Form(enctype='multipart/form-data')
form.add(StringWidget, 'name', title=_('Name'), required=True, size=50)
form.add_submit('submit', _('Add'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('..')
if form.is_submitted() and not form.has_errors():
name = form.get_widget('name').parse()
slug = '_%s' % misc.simplify(name)
self.workflow.roles[slug] = name
# go over all existing status and update their visibility
# restrictions if necessary
for status in self.workflow.possible_status:
if status.get_visibility_restricted_roles():
status.visibility = self.workflow.roles.keys()
self.workflow.store()
return redirect('..')
get_response().breadcrumb.append(('new', _('New Function')))
html_top('workflows', title=_('New Function'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('New Function')
r += form.render()
return r.getvalue()
def _q_lookup(self, component):
function = self.workflow.roles.get('_' + component)
if not function:
raise errors.TraversalError()
form = Form(enctype='multipart/form-data')
form.add(StringWidget, 'name', title=_('Name'), required=True, size=50,
value=function)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
if component != 'receiver':
# do not allow removing the standard "receiver" function.
# TODO: do not display "delete" for functions that are currently in
# use.
form.add_submit('delete', _('Delete'))
if form.get_widget('cancel').parse():
return redirect('..')
if form.get_submit() == 'delete':
slug = '_%s' % component
del self.workflow.roles[slug]
self.workflow.store()
return redirect('..')
if form.is_submitted() and not form.has_errors():
name = form.get_widget('name').parse()
slug = '_%s' % component
self.workflow.roles[slug] = name
self.workflow.store()
return redirect('..')
get_response().breadcrumb.append(('new', _('Edit Function')))
html_top('workflows', title=_('Edit Function'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('Edit Function')
r += form.render()
return r.getvalue()
def _q_index(self):
return redirect('..')
class CriticalityLevelsDirectory(Directory):
_q_exports = ['', 'new']
def __init__(self, workflow):
self.workflow = workflow
def _q_traverse(self, path):
get_response().breadcrumb.append(
('criticality-levels/', _('Criticality Levels')))
return Directory._q_traverse(self, path)
def new(self):
currentlevels = self.workflow.criticality_levels or []
default_colours = ['FFFFFF', 'FFFF00', 'FF9900', 'FF6600', 'FF0000']
try:
default_colour = default_colours[len(currentlevels)]
except IndexError:
default_colour = '000000'
form = Form(enctype='multipart/form-data')
form.add(StringWidget, 'name', title=_('Name'), required=True, size=50)
form.add(ColourWidget, 'colour', title=_('Colour'), required=False,
value=default_colour)
form.add_submit('submit', _('Add'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('..')
if form.is_submitted() and not form.has_errors():
if not self.workflow.criticality_levels:
self.workflow.criticality_levels = []
level = WorkflowCriticalityLevel()
level.name = form.get_widget('name').parse()
level.colour = form.get_widget('colour').parse()
self.workflow.criticality_levels.append(level)
self.workflow.store()
return redirect('..')
get_response().breadcrumb.append(('new', _('New Criticality Level')))
html_top('workflows', title=_('New Criticality level'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('New Criticality Level')
r += form.render()
return r.getvalue()
def _q_lookup(self, component):
for level in (self.workflow.criticality_levels or []):
if level.id == component:
break
else:
raise errors.TraversalError()
form = Form(enctype='multipart/form-data')
form.add(StringWidget, 'name', title=_('Name'), required=True, size=50,
value=level.name)
form.add(ColourWidget, 'colour', title=_('Colour'), required=False,
value=level.colour)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
form.add_submit('delete-level', _('Delete'))
if form.get_widget('cancel').parse():
return redirect('..')
if form.get_submit() == 'delete-level':
self.workflow.criticality_levels.remove(level)
self.workflow.store()
return redirect('..')
if form.is_submitted() and not form.has_errors():
level.name = form.get_widget('name').parse()
level.colour = form.get_widget('colour').parse()
self.workflow.store()
return redirect('..')
get_response().breadcrumb.append(('new', _('Edit Criticality Level')))
html_top('workflows', title=_('Edit Criticality Level'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('Edit Criticality Level')
r += form.render()
return r.getvalue()
def _q_index(self):
return redirect('..')
class GlobalActionPage(WorkflowStatusPage):
_q_exports = ['', 'new', 'delete', 'newitem', ('items', 'items_dir'),
'update_order', 'edit', 'newtrigger', ('triggers', 'triggers_dir'),
'update_triggers_order',
('backoffice-info-text', 'backoffice_info_text'),]
def __init__(self, workflow, action_id, html_top):
self.html_top = html_top
self.workflow = workflow
try:
self.action = [x for x in self.workflow.global_actions if x.id == action_id][0]
except IndexError:
raise errors.TraversalError()
self.status = self.action
self.items_dir = GlobalActionItemsDir(workflow, self.action, html_top)
self.triggers_dir = GlobalActionTriggersDir(workflow, self.action, html_top)
def _q_traverse(self, path):
get_response().breadcrumb.append(
('global-actions/%s/' % self.action.id, _('Global Action: %s') % self.action.name))
return Directory._q_traverse(self, path)
def is_item_available(self, item):
return item.is_available(self.workflow) and item.ok_in_global_action
def _q_index(self):
self.html_top('%s - %s' % (_('Workflow'), self.workflow.name))
r = TemplateIO(html=True)
get_response().add_javascript(['jquery.js', 'jquery-ui.js', 'biglist.js',
'qommon.wysiwyg.js'])
r += htmltext('<h2>%s</h2>') % self.action.name
r += get_session().display_message()
r += htmltext('<div class="bo-block">')
r += htmltext('<h2>%s</h2>') % _('Actions')
if not self.action.items:
r += htmltext('<p>%s</p>') % _('There are not yet any items in this action.')
else:
if str(self.workflow.id).startswith('_'):
r += htmltext('<ul id="items-list" class="biglist">')
else:
r += htmltext('<p class="items">')
r += _('Use drag and drop with the handles to reorder items.')
r += htmltext('</p>')
r += htmltext('<ul id="items-list" class="biglist sortable">')
for i, item in enumerate(self.action.items):
r += htmltext('<li class="biglistitem" id="itemId_%s">') % item.id
if str(self.workflow.id).startswith('_'):
r += item.render_as_line()
else:
if hasattr(item, 'fill_admin_form'):
r += htmltext('<a href="items/%s/">%s</a>') % (item.id, item.render_as_line())
else:
r += item.render_as_line()
r += htmltext('<p class="commands">')
if hasattr(item, 'fill_admin_form'):
r += command_icon('items/%s/' % item.id, 'edit')
r += command_icon('items/%s/delete' % item.id, 'remove', popup = True)
r += htmltext('</p>')
r += htmltext('</li>')
r += htmltext('</ul>')
r += htmltext('</div>') # bo-block
r += htmltext('<div class="bo-block">')
r += htmltext('<h2>%s</h2>') % _('Triggers')
r += htmltext('<ul id="items-list" class="biglist sortable" data-order-function="update_triggers_order">')
for trigger in self.action.triggers:
r += htmltext('<li class="biglistitem" id="trigId_%s">') % trigger.id
r += htmltext('<a rel="popup" href="triggers/%s/">%s</a>') % (
trigger.id, trigger.render_as_line())
r += htmltext('<p class="commands">')
r += command_icon('triggers/%s/' % trigger.id, 'edit', popup=True)
r += command_icon('triggers/%s/delete' % trigger.id, 'remove', popup=True)
r += htmltext('</li>')
r+= htmltext('</ul>')
r += htmltext('</div>') # bo-block
r += htmltext('<p><a href="../../">%s</a></p>') % _('Back to workflow main page')
get_response().filter['sidebar'] = self.get_sidebar()
return r.getvalue()
def delete(self):
form = Form(enctype='multipart/form-data')
form.widgets.append(HtmlWidget('<p>%s</p>' % _(
'You are about to remove an action.')))
form.add_submit('delete', _('Delete'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('.')
if not form.is_submitted() or form.has_errors():
get_response().breadcrumb.append(('delete', _('Delete')))
self.html_top(title = _('Delete Action'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s %s</h2>') % (_('Deleting Action:'), self.action.name)
r += form.render()
return r.getvalue()
del self.workflow.global_actions[self.workflow.global_actions.index(self.action)]
self.workflow.store()
return redirect('../../')
def edit(self):
form = Form(enctype = 'multipart/form-data')
form.add(StringWidget, 'name', title=_('Action Name'), required=True,
size=30, value=self.action.name)
form.add_submit('submit', _('Submit'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('.')
if form.is_submitted() and not form.has_errors():
new_name = str(form.get_widget('name').parse())
if [x for x in self.workflow.global_actions if x.name == new_name]:
form.get_widget('name').set_error(
_('There is already an action with that name.'))
else:
self.action.name = new_name
self.workflow.store()
return redirect('.')
self.html_top(title=_('Edit Action Name'))
get_response().breadcrumb.append( ('edit', _('Edit')) )
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('Edit Action Name')
r += form.render()
return r.getvalue()
def get_sidebar(self):
get_response().add_javascript(['jquery.js', 'jquery-ui.js', 'popup.js',
'jquery.colourpicker.js'])
r = TemplateIO(html=True)
if str(self.workflow.id).startswith('_'):
r += htmltext('<p>')
r += _('''This is the default workflow, you cannot edit it but you can
duplicate it to base your own workflow on it.''')
r += htmltext('</p>')
else:
r += htmltext('<ul id="sidebar-actions">')
r += htmltext('<li><a href="edit" rel="popup">%s</a></li>') % _('Change Action Name')
r += htmltext('<li><a href="backoffice-info-text" rel="popup">%s</a></li>'
) % _('Change Backoffice Information Text')
r += htmltext('<li><a href="delete" rel="popup">%s</a></li>') % _('Delete')
r += htmltext('</ul>')
r += htmltext('<div id="new-field">')
r += htmltext('<h3>%s</h3>') % _('New Item')
r += self.get_new_item_form().render()
r += htmltext('</div>')
r += htmltext('<div id="new-trigger">')
r += htmltext('<h3>%s</h3>') % _('New Trigger')
r += self.get_new_trigger_form().render()
r += htmltext('</div>')
return r.getvalue()
def update_triggers_order(self):
request = get_request()
new_order = request.form['order'].strip(';').split(';')
self.action.triggers = [ [x for x in self.action.triggers if x.id == y][0] for y in new_order]
self.workflow.store()
return 'ok'
def newtrigger(self):
form = self.get_new_trigger_form()
if not form.is_submitted() or form.has_errors():
get_session().message = ('error', _('Submitted form was not filled properly.'))
return redirect('.')
if form.get_widget('type').parse():
self.action.append_trigger(form.get_widget('type').parse())
else:
get_session().message = ('error', _('Submitted form was not filled properly.'))
return redirect('.')
self.workflow.store()
return redirect('.')
def get_new_trigger_form(self):
form = Form(enctype='multipart/form-data', action='newtrigger')
available_triggers = [
('timeout', _('Automatic')),
('manual', _('Manual')),
]
form.add(SingleSelectWidget, 'type', title=_('Type'),
required=True, options=available_triggers)
form.add_submit('submit', _('Add'))
return form
class GlobalActionsDirectory(Directory):
_q_exports = ['', 'new']
def __init__(self, workflow, html_top):
self.workflow = workflow
self.html_top = html_top
def _q_lookup(self, component):
return GlobalActionPage(self.workflow, component, self.html_top)
def _q_index(self):
return redirect('..')
def new(self):
form = Form(enctype='multipart/form-data')
form.add(StringWidget, 'name', title=_('Name'), required=True, size=50)
form.add_submit('submit', _('Add'))
form.add_submit('cancel', _('Cancel'))
if form.get_widget('cancel').parse():
return redirect('..')
if form.is_submitted() and not form.has_errors():
name = form.get_widget('name').parse()
try:
action = self.workflow.add_global_action(name)
except DuplicateGlobalActionNameError:
form.get_widget('name').set_error(
_('There is already an action with that name.'))
else:
self.workflow.store()
return redirect('%s/' % action.id)
get_response().breadcrumb.append(('new', _('New Global Action')))
html_top('workflows', title=_('New Global Action'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('New Global Action')
r += form.render()
return r.getvalue()
class WorkflowPage(Directory):
_q_exports = ['', 'edit', 'delete', 'newstatus', ('status', 'status_dir'), 'update_order',
'duplicate', 'export', 'svg', ('variables', 'variables_dir'), 'inspect',
('schema.svg', 'svg'),
('backoffice-fields', 'backoffice_fields_dir'),
'update_actions_order', 'update_criticality_levels_order',
('functions', 'functions_dir'), ('global-actions', 'global_actions_dir'),
('criticality-levels', 'criticality_levels_dir'),
('logged-errors', 'logged_errors_dir'),
]
def __init__(self, component, html_top):
try:
self.workflow = Workflow.get(component)
except KeyError:
raise errors.TraversalError()
self.html_top = html_top
self.workflow_ui = WorkflowUI(self.workflow)
self.status_dir = WorkflowStatusDirectory(self.workflow, html_top)
self.variables_dir = VariablesDirectory(self.workflow)
self.backoffice_fields_dir = BackofficeFieldsDirectory(self.workflow)
self.functions_dir = FunctionsDirectory(self.workflow)
self.global_actions_dir = GlobalActionsDirectory(self.workflow, html_top)
self.criticality_levels_dir = CriticalityLevelsDirectory(self.workflow)
self.logged_errors_dir = LoggedErrorsDirectory(parent_dir=self, workflow_id=self.workflow.id)
get_response().breadcrumb.append((component + '/', self.workflow.name))
def _q_index(self):
self.html_top(title = _('Workflow - %s') % self.workflow.name)
r = TemplateIO(html=True)
get_response().add_javascript(['jquery.js', 'jquery-ui.js', 'biglist.js',
'svg-pan-zoom.js', 'jquery.colourpicker.js'])
get_response().add_javascript_code('$(function () { svgPanZoom("svg", {controlIconsEnabled: true}); });')
r += htmltext('<div id="appbar">')
r += htmltext('<h2>%s</h2>') % self.workflow.name
r += htmltext('<span class="actions">')
r += htmltext('<a rel="popup" href="edit">%s</a>') % _('change title')
r += htmltext('</span>')
r += htmltext('</div>')
if self.workflow.last_modification_time:
warning_class = ''
if (time.time() - time.mktime(self.workflow.last_modification_time)) < 600:
if get_request().user and str(get_request().user.id) != self.workflow.last_modification_user_id:
warning_class = 'recent'
r += htmltext('<p class="last-modification %s">') % warning_class
r += _('Last Modification:')
r += ' '
r += misc.localstrftime(self.workflow.last_modification_time)
r += ' '
if self.workflow.last_modification_user_id:
try:
r += _('by %s') % get_publisher().user_class.get(
self.workflow.last_modification_user_id).display_name
except KeyError:
pass
r += htmltext('</p>')
r += get_session().display_message()
r += htmltext('<div class="splitcontent-left">')
r += htmltext('<div class="bo-block">')
r += htmltext('<h3>%s</h3>') % _('Possible Status')
if not self.workflow.possible_status:
r += htmltext('<p>%s</p>') % _('There are not yet any status defined in this workflow.')
else:
if not str(self.workflow.id).startswith(str('_')):
r += htmltext('<p class="hint">')
r += _('Use drag and drop with the handles to reorder status.')
r += htmltext('</p>')
r += htmltext('<ul id="status-list" class="biglist sortable">')
else:
r += htmltext('<ul id="status-list" class="biglist">')
for status in self.workflow.possible_status:
klass = ['biglistitem']
if status.get_visibility_restricted_roles():
klass.append('hidden-status')
r += htmltext('<li class="%s" id="itemId_%s">') % (
' '.join(klass), status.id)
attrs = ''
if status.colour:
attrs = 'style="border-color: #%s"' % status.colour
r += htmltext('<a href="status/%s/" %s>' % (status.id, attrs))
r += htmltext('%s</a>') % status.name
r += htmltext('</li>')
r += htmltext('</ul>')
r += htmltext('</div>')
r += htmltext('</div>') # .splitcontent-left
r += htmltext('<div class="splitcontent-right">')
r += htmltext('<div class="bo-block">')
r += htmltext('<h3>%s') % _('Workflow Functions')
if not str(self.workflow.id).startswith('_'):
r += htmltext(' <span class="change">(<a rel="popup" href="functions/new">%s</a>)</span>') % _('add function')
r += htmltext('</h3>')
r += htmltext('<ul id="roles-list" class="biglist">')
for key, label in (self.workflow.roles or {}).items():
r += htmltext('<li class="biglistitem">')
if not str(self.workflow.id).startswith('_'):
r += htmltext('<a rel="popup" href="functions/%s">%s</a>') % (key[1:], label)
else:
r += htmltext('<a>%s</a>') % label
r += htmltext('</li>')
r += htmltext('</ul>')
r += htmltext('</div>')
if not str(self.workflow.id).startswith('_'):
r += htmltext('<div class="bo-block">')
r += htmltext('<h3>%s') % _('Workflow Variables')
r += htmltext(' <span class="change">(<a href="variables/">%s</a>)</span></h3>') % _('change')
if self.workflow.variables_formdef:
r += htmltext('<ul class="biglist">')
for field in self.workflow.variables_formdef.fields:
if field.varname:
r += htmltext('<li><a href="variables/fields/%s/">%s') % (
field.id, field.label)
if not '*' in field.varname:
r += htmltext(' <code class="varname">{{form_option_%s}}</code>') % field.varname
r += htmltext('</a></li>')
r += htmltext('</ul>')
r += htmltext('</div>')
if not str(self.workflow.id).startswith('_'):
r += htmltext('<div class="bo-block">')
r += htmltext('<h3>%s') % _('Global Actions')
if not str(self.workflow.id).startswith('_'):
r += htmltext(' <span class="change">(<a rel="popup" href="global-actions/new">%s</a>)</span>') % _('add global action')
r += htmltext('</h3>')
if not str(self.workflow.id).startswith('_'):
r += htmltext('<ul id="status-list" class="biglist sortable" '
'data-order-function="update_actions_order">')
else:
r += htmltext('<ul class="biglist">')
for action in (self.workflow.global_actions or []):
r += htmltext('<li class="biglistitem" id="itemId_%s">' % action.id)
if not str(self.workflow.id).startswith('_'):
r += htmltext('<a href="global-actions/%s/">%s</a>') % (
action.id, action.name)
else:
r += htmltext('<a>%s</a>') % action.name
r += htmltext('</li>')
r += htmltext('</ul>')
r += htmltext('</div>')
if not str(self.workflow.id).startswith('_'):
r += htmltext('<div class="bo-block">')
r += htmltext('<h3>%s') % _('Criticality Levels')
if not str(self.workflow.id).startswith('_'):
r += htmltext(' <span class="change">'
'(<a rel="popup" href="criticality-levels/new">'
'%s</a>)</span>') % _('add criticality level')
r += htmltext('</h3>')
r += htmltext('<ul class="biglist sortable criticality-levels" '
'data-order-function="update_criticality_levels_order">')
for level in (self.workflow.criticality_levels or []):
style = ''
if level.colour:
style = 'style="border-left-color: #%s"' % level.colour
r += htmltext('<li class="biglistitem" id="itemId_%s" %s>' % (level.id, style))
if not str(self.workflow.id).startswith('_'):
r += htmltext('<a rel="popup" href="criticality-levels/%s">%s</a>') % (
level.id, level.name)
else:
r += htmltext('<a>%s</a>') % level.name
r += htmltext('</li>')
r += htmltext('</ul>')
r += htmltext('</div>')
if not str(self.workflow.id).startswith('_'):
r += htmltext('<div class="bo-block">')
r += htmltext('<h3>%s') % _('Backoffice Fields')
r += htmltext(' <span class="change">(<a href="backoffice-fields/">%s</a>)</span></h3>') % _('change')
if self.workflow.backoffice_fields_formdef:
r += htmltext('<ul class="biglist">')
for field in self.workflow.backoffice_fields_formdef.fields:
r += htmltext('<li><a href="backoffice-fields/fields/%s/">%s') % (
field.id, field.label)
if field.varname:
r += htmltext(' <code class="varname">{{form_var_%s}}</code>') % field.varname
r += htmltext('</a></li>')
r += htmltext('</ul>')
r += htmltext('</div>')
r += htmltext('</div>') # .splitcontent-right
r += htmltext('<br style="clear:both;"/>')
if self.workflow.possible_status:
r += htmltext('<div class="bo-block">')
r += htmltext(graphviz(self.workflow, include=True))
r += htmltext('<div class="full-screen-link"><a href="schema.svg">%s</a></div>') % _('Full Screen')
r += htmltext('</div>') # bo-block
formdefs = [x for x in FormDef.select() if x.workflow_id == self.workflow.id]
if formdefs:
r += htmltext('<div class="bo-block">')
r += htmltext('<h3>%s</h3>') % _('Forms')
r += htmltext('<p>%s ') % _('This workflow is used for the following forms:')
r += htmltext(', ').join([htmltext('<a href="../../forms/%s/">%s</a>') % (x.id, x.name) for x in formdefs])
r += htmltext('</p>')
r += htmltext('</div>')
get_response().filter['sidebar'] = self.get_sidebar()
return r.getvalue()
def get_sidebar(self):
r = TemplateIO(html=True)
if str(self.workflow.id).startswith(str('_')):
r += htmltext('<p>')
r += _('''This is the default workflow, you cannot edit it but you can
duplicate it to base your own workflow on it.''')
r += htmltext('</p>')
r += htmltext('<ul id="sidebar-actions">')
if not str(self.workflow.id).startswith(str('_')):
r += htmltext('<li><a href="delete" rel="popup">%s</a></li>') % _('Delete')
r += htmltext('<li><a href="duplicate">%s</a></li>') % _('Duplicate')
r += htmltext('<li><a href="export">%s</a></li>') % _('Export')
r += htmltext('</ul>')
if not str(self.workflow.id).startswith(str('_')):
r += self.get_new_status_form()
r += LoggedErrorsDirectory.errors_block(workflow_id=self.workflow.id)
return r.getvalue()
def expand_workflow_formdef(self, formdef):
r = TemplateIO(html=True)
r += htmltext('<ul>')
for field in formdef.fields:
r += htmltext('<li>')
r += field.label
if getattr(field, 'required', True):
r += htmltext(' (%s)') % _('required')
r += htmltext(' (%s)') % _(field.description)
if field.varname:
r += htmltext(' (<tt>%s</tt>)') % field.varname
r += htmltext('</li>')
r += htmltext('</ul>')
return r.getvalue()
def inspect(self):
self.html_top('%s - %s' % (_('Workflow'), self.workflow.name))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % self.workflow.name
r += htmltext('<h2>%s</h2>') % _('Workflow Functions')
r += htmltext('<ul>')
for key, label in (self.workflow.roles or {}).items():
r += htmltext('<li>%s</li>') % label
r += htmltext('</ul>')
if self.workflow.variables_formdef:
r += htmltext('<h2>%s</h2>') % _('Workflow Variables')
r += self.expand_workflow_formdef(self.workflow.variables_formdef)
if self.workflow.backoffice_fields_formdef:
r += htmltext('<h2>%s</h2>') % _('Backoffice Fields')
r += self.expand_workflow_formdef(self.workflow.backoffice_fields_formdef)
if self.workflow.criticality_levels:
r += htmltext('<h2>%s</h2>') % _('Criticality Levels')
r += htmltext('<ul>')
for level in (self.workflow.criticality_levels or []):
r += htmltext('<li>%s</li>') % level.name
r += htmltext('</ul>')
r += htmltext('<h2>%s</h2>') % _('Statuses')
r += htmltext('<div class="expanded-statuses">')
for status in self.workflow.possible_status or []:
r += htmltext('<div class="status" style="border-left-color: #%s;">' %
(getattr(status, 'colour', None) or 'fff'))
r += htmltext('<h3 id="status-%s"><a href="status/%s/">%s</a></h3>') % (
status.id, status.id, status.name)
if status.backoffice_info_text:
r += htmltext('<div>')
r += htmltext(status.backoffice_info_text)
r += htmltext('</div>')
if not status.items:
r += htmltext('<p>%s</p>') % _('No actions in this status.')
for item in status.items or []:
r += htmltext('<h4>%s</h4>') % _(item.description)
r += item.get_parameters_view()
r += htmltext('</div>')
r += htmltext('</div>')
if self.workflow.global_actions:
r += htmltext('<h2>%s</h2>') % _('Global Actions')
r += htmltext('<div class="expanded-statuses">')
for action in self.workflow.global_actions:
r += htmltext('<div class="status">')
r += htmltext('<h3><a href="global-actions/%s/">%s</a></h3>') % (
action.id, action.name)
r += htmltext('<ul>')
for trigger in action.triggers:
r += htmltext('<li>%s</li>') % trigger.render_as_line()
r += htmltext('</ul>')
r += htmltext('</h3>')
for item in action.items or []:
r += htmltext('<h4>%s</h4>') % _(item.description)
r += item.get_parameters_view()
r += htmltext('</div>')
r += htmltext('</div>')
return r.getvalue()
def svg(self):
response = get_response()
response.set_content_type('image/svg+xml')
root_url = get_publisher().get_application_static_files_root_url()
css = root_url + get_publisher().qommon_static_dir + get_publisher().qommon_admin_css
return graphviz(self.workflow, include=False).replace('?>',
'?>\n<?xml-stylesheet href="%s" type="text/css"?>\n' % css)
def export(self):
x = self.workflow.export_to_xml(include_id=True)
misc.indent_xml(x)
response = get_response()
response.set_content_type('application/x-wcs-form')
response.set_header('content-disposition',
'attachment; filename=workflow-%s.wcs' % misc.simplify(self.workflow.name))
return '<?xml version="1.0" encoding="utf-8"?>\n' + ET.tostring(x)
def get_new_status_form(self):
r = TemplateIO(html=True)
r += htmltext('<div id="new-field">')
r += htmltext('<h3>%s</h3>') % _('New Status')
form = Form(enctype='multipart/form-data', action = 'newstatus')
form.add(StringWidget, 'name', title = _('Name'), required = True, size = 50)
form.add_submit('submit', _('Add'))
r += form.render()
r += htmltext('</div>')
return r.getvalue()
def update_order(self):
request = get_request()
new_order = request.form['order'].strip(';').split(';')
self.workflow.possible_status = [ [x for x in self.workflow.possible_status if \
x.id == y][0] for y in new_order]
self.workflow.store()
return 'ok'
def update_actions_order(self):
request = get_request()
new_order = request.form['order'].strip(';').split(';')
self.workflow.global_actions = [ [x for x in self.workflow.global_actions if
x.id == y][0] for y in new_order]
self.workflow.store()
return 'ok'
def update_criticality_levels_order(self):
request = get_request()
new_order = request.form['order'].strip(';').split(';')
self.workflow.criticality_levels = [
[x for x in self.workflow.criticality_levels if x.id == y][0] for y in new_order]
self.workflow.store()
return 'ok'
def newstatus(self):
form = Form(enctype='multipart/form-data', action = 'newstatus')
form.add(StringWidget, 'name', title = _('Name'), size = 50)
if not form.is_submitted() or form.has_errors():
get_session().message = ('error', _('Submitted form was not filled properly.'))
return redirect('.')
if form.get_widget('name').parse():
try:
self.workflow.add_status(form.get_widget('name').parse())
except DuplicateStatusNameError:
get_session().message = ('error', _('There is already a status with that name.'))
return redirect('.')
else:
get_session().message = ('error', _('Submitted form was not filled properly.'))
return redirect('.')
self.workflow.store()
return redirect('.')
def edit(self, duplicate = False):
form = self.workflow_ui.form_edit()
if form.get_widget('cancel').parse():
return redirect('.')
if form.is_submitted() and not form.has_errors():
try:
self.workflow_ui.submit_form(form)
except ValueError:
pass
else:
return redirect('.')
self.html_top(title = _('Edit Workflow'))
r = TemplateIO(html=True)
if duplicate:
get_response().breadcrumb.append( ('edit', _('Duplicate')) )
r += htmltext('<h2>%s</h2>') % _('Duplicate Workflow')
else:
get_response().breadcrumb.append( ('edit', _('Edit')) )
r += htmltext('<h2>%s</h2>') % _('Edit Workflow')
r += form.render()
return r.getvalue()
def delete(self):
form = Form(enctype="multipart/form-data")
for formdef in FormDef.select():
if formdef.workflow_id == self.workflow.id:
form.widgets.append(HtmlWidget('<p>%s</p>' % _(
"This workflow is currently in use, you cannot remove it.")))
form.add_submit("cancel", _("Cancel"))
break
else:
form.widgets.append(HtmlWidget('<p>%s</p>' % _(
"You are about to irrevocably delete this workflow.")))
form.add_submit('delete', _('Delete'))
form.add_submit("cancel", _("Cancel"))
if form.get_widget('cancel').parse():
return redirect('.')
if not form.is_submitted() or form.has_errors():
get_response().breadcrumb.append(('delete', _('Delete')))
self.html_top(title = _('Delete Workflow'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s %s</h2>') % (_('Deleting Workflow:'), self.workflow.name)
r += form.render()
return r.getvalue()
else:
self.workflow.remove_self()
return redirect('..')
def duplicate(self):
self.workflow_ui.workflow.id = None
original_name = self.workflow_ui.workflow.name
self.workflow_ui.workflow.name = self.workflow_ui.workflow.name + _(' (copy)')
workflow_names = [x.name for x in Workflow.select()]
no = 2
while self.workflow_ui.workflow.name in workflow_names:
self.workflow_ui.workflow.name = _('%(name)s (copy %(no)d)') % {
'name': original_name, 'no': no}
no += 1
self.workflow_ui.workflow.store()
return redirect('../%s/' % self.workflow_ui.workflow.id)
class NamedDataSourcesDirectoryInWorkflows(NamedDataSourcesDirectory):
def _q_traverse(self, path):
get_response().breadcrumb.append(('workflows/', _('Workflows')))
return super(NamedDataSourcesDirectoryInWorkflows, self)._q_traverse(path)
class WorkflowsDirectory(Directory):
_q_exports = ['', 'new', ('import', 'p_import'),
('data-sources', 'data_sources')]
data_sources = NamedDataSourcesDirectoryInWorkflows()
def html_top(self, title):
return html_top('workflows', title)
def _q_index(self):
get_response().breadcrumb.append( ('workflows/', _('Workflows')) )
self.html_top(title = _('Workflows'))
r = TemplateIO(html=True)
r += htmltext('<div id="appbar">')
r += htmltext('<h2>%s</h2>') % _('Workflows')
r += htmltext('<span class="actions">')
r += htmltext('<a href="data-sources/">%s</a>') % _('Data sources')
r += htmltext('<a href="import" rel="popup">%s</a>') % _('Import')
r += htmltext('<a class="new-item" rel="popup" href="new">%s</a>') % _('New Workflow')
r += htmltext('</span>')
r += htmltext('</div>')
r += htmltext('<ul class="biglist">')
workflows_in_use = set(['_default'])
for formdef in FormDef.select():
workflows_in_use.add(str(formdef.workflow_id))
workflows = [Workflow.get_default_workflow()] + Workflow.select(order_by='name')
has_unused_workflows = False
for workflow in workflows:
if not str(workflow.id) in workflows_in_use:
has_unused_workflows = True
continue
r += htmltext('<li>')
r += htmltext('<strong class="label"><a href="%s/">%s</a></strong>') % (workflow.id, workflow.name)
r += htmltext('</li>')
r += htmltext('</ul>')
if has_unused_workflows:
r += htmltext('<h2>%s</h2>') % _('Unused workflows')
r += htmltext('<ul class="biglist">')
for workflow in workflows:
if str(workflow.id) in workflows_in_use:
continue
r += htmltext('<li>')
r += htmltext('<strong class="label"><a href="%s/">%s</a></strong>') % (workflow.id, workflow.name)
r += htmltext('</li>')
r += htmltext('</ul>')
return r.getvalue()
def new(self):
get_response().breadcrumb.append( ('workflows/', _('Workflows')) )
get_response().breadcrumb.append( ('new', _('New')) )
workflow_ui = WorkflowUI(None)
form = workflow_ui.form_new()
if form.get_widget('cancel').parse():
return redirect('.')
if form.is_submitted() and not form.has_errors():
try:
workflow = workflow_ui.submit_form(form)
except ValueError:
pass
else:
return redirect('%s/' % workflow.id)
self.html_top(title = _('New Workflow'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('New Workflow')
r += form.render()
return r.getvalue()
def _q_lookup(self, component):
get_response().breadcrumb.append( ('workflows/', _('Workflows')) )
return WorkflowPage(component, html_top=self.html_top)
def p_import(self):
form = Form(enctype = 'multipart/form-data')
form.add(FileWidget, 'file', title=_('File'), required=False)
form.add(UrlWidget, 'url', title=_('Address'), required=False,
size=50)
form.add_submit('submit', _('Import Workflow'))
form.add_submit('cancel', _('Cancel'))
if form.get_submit() == 'cancel':
return redirect('.')
if form.is_submitted() and not form.has_errors():
try:
return self.import_submit(form)
except ValueError:
pass
get_response().breadcrumb.append( ('workflows/', _('Workflows')) )
get_response().breadcrumb.append( ('import', _('Import')) )
self.html_top(title=_('Import Workflow'))
r = TemplateIO(html=True)
r += htmltext('<h2>%s</h2>') % _('Import Workflow')
r += htmltext('<p>%s</p>') % _(
'You can install a new workflow by uploading a file '\
'or by pointing to the workflow URL.')
r += form.render()
return r.getvalue()
def import_submit(self, form):
if form.get_widget('file').parse():
fp = form.get_widget('file').parse().fp
elif form.get_widget('url').parse():
url = form.get_widget('url').parse()
try:
fp = misc.urlopen(url)
except misc.ConnectionError as e:
form.set_error('url', _('Error loading form (%s).') % str(e))
raise ValueError()
else:
form.set_error('file', _('You have to enter a file or a URL.'))
raise ValueError()
error, reason = False, None
try:
workflow = Workflow.import_from_xml(fp)
except WorkflowImportError as e:
error = True
reason = _(e) % e.msg_args
except ValueError:
error = True
if error:
if reason:
msg = _('Invalid File (%s)') % reason
else:
msg = _('Invalid File')
if form.get_widget('url').parse():
form.set_error('url', msg)
else:
form.set_error('file', msg)
raise ValueError()
initial_workflow_name = workflow.name
workflow_names = [x.name for x in Workflow.select()]
copy_no = 1
while workflow.name in workflow_names:
if copy_no == 1:
workflow.name = _('Copy of %s') % initial_workflow_name
else:
workflow.name = _('Copy of %(name)s (%(no)d)') % {
'name': initial_workflow_name, 'no': copy_no}
copy_no += 1
workflow.store()
get_session().message = ('info',
_('This workflow has been successfully imported.'))
return redirect('%s/' % workflow.id)