def get_user_conf(user_id, configuration, include_meta=False):
"""Return user profile and settings"""
conf = {}
profile = load_profile(user_id, configuration, include_meta)
if profile:
conf.update(profile)
settings = load_settings(user_id, configuration, include_meta)
if settings:
conf.update(settings)
return conf
def get_user_conf(user_id, configuration, include_meta=False):
"""Return user profile and settings"""
conf = {}
profile = load_profile(user_id, configuration, include_meta)
if profile:
conf.update(profile)
settings = load_settings(user_id, configuration, include_meta)
if settings:
conf.update(settings)
return conf
def main(client_id, user_arguments_dict):
"""Main function used by front end"""
(configuration, logger, output_objects, op_name) = \
initialize_main_variables(client_id, op_header=False)
client_dir = client_id_dir(client_id)
defaults = signature()[1]
(validate_status, accepted) = validate_input_and_cert(
user_arguments_dict,
defaults,
output_objects,
client_id,
configuration,
allow_rejects=False,
)
if not validate_status:
return (accepted, returnvalues.CLIENT_ERROR)
# Please note that base_dir must end in slash to avoid access to other
# user dirs when own name is a prefix of another user name
base_dir = os.path.abspath(os.path.join(configuration.user_home,
client_dir)) + os.sep
title_entry = find_entry(output_objects, 'title')
title_entry['text'] = 'Settings'
# prepare support for toggling the views (by css/jquery)
title_entry['style'] = themed_styles(configuration)
title_entry['style']['skin'] += '''
%s
''' % cm_css
title_entry['javascript'] = '''
<script type="text/javascript" src="/images/js/jquery.js"></script>
<script type="text/javascript" src="/images/js/jquery-ui.js"></script>
%s
<script type="text/javascript" >
var toggleHidden = function(classname) {
// classname supposed to have a leading dot
$(classname).toggleClass("hidden");
}
$(document).ready(function() {
}
);
</script>
''' % cm_javascript
valid_topics = ['general', 'style']
active_menu = extract_menu(configuration, title_entry)
if 'submitjob' in active_menu:
valid_topics.append('job')
if 'people' in active_menu:
valid_topics.append('profile')
if configuration.site_script_deps:
valid_topics.append('widgets')
if configuration.arc_clusters:
valid_topics.append('arc')
if configuration.site_enable_sftp:
valid_topics.append('sftp')
if configuration.site_enable_davs:
valid_topics.append('webdavs')
if configuration.site_enable_ftps:
valid_topics.append('ftps')
topics = accepted['topic']
# Backwards compatibility
if topics and topics[0] == 'ssh':
topics[0] = 'sftp'
topics = [i for i in topics if i in valid_topics]
# Default to general if no valid topics given
if not topics:
topics.append(valid_topics[0])
topic_titles = dict([(i, i.title()) for i in valid_topics])
for (key, val) in [('sftp', 'SFTP'), ('webdavs', 'WebDAVS'),
('ftps', 'FTPS')]:
if key in valid_topics:
topic_titles[key] = val
output_objects.append({'object_type': 'header', 'text'
: 'Settings'})
links = []
for name in valid_topics:
active_menu = ''
if topics[0] == name:
active_menu = 'activebutton'
links.append({'object_type': 'link',
'destination': "settings.py?topic=%s" % name,
'class': '%ssettingslink settingsbutton %s' % \
(name, active_menu),
'title': 'Switch to %s settings' % topic_titles[name],
'text' : '%s' % topic_titles[name],
})
output_objects.append({'object_type': 'multilinkline', 'links': links,
'sep': ' '})
output_objects.append({'object_type': 'text', 'text': ''})
# load current settings
current_settings_dict = load_settings(client_id, configuration)
if not current_settings_dict:
# no current settings found
current_settings_dict = {}
if not topics:
output_objects.append({'object_type': 'error_text', 'text':
'No valid topics!'})
return (output_objects, returnvalues.CLIENT_ERROR)
if 'general' in topics:
html = \
'''
<div id="settings">
<form method="post" action="settingsaction.py">
<table class="settings fixedlayout">
<tr class="title"><td class="centertext">
Select your %s settings
</td></tr>
<tr><td>
</td></tr>
<tr><td>
<input type="hidden" name="topic" value="general" />
Please note that if you want to set multiple values (e.g. addresses)
in the same field, you must write each value on a separate line but
without blank lines.
</td></tr>
<tr><td>
</td></tr>
''' % configuration.short_title
settings_entries = get_settings_specs()
for (keyword, val) in settings_entries:
if 'SUBMITUI' == keyword and \
'job' not in valid_topics:
continue
if 'notify' == val['Context'] and \
keyword.lower() not in configuration.notify_protocols:
continue
entry = \
"""
<tr class='title'><td>
%s
</td></tr>
<tr><td>
%s
</td></tr>
<tr><td>
"""\
% (keyword.replace('_', ' ').title(), val['Description'])
if val['Type'] == 'multiplestrings':
try:
# get valid choices from conf. multiple selections
valid_choices = eval('configuration.%s' % keyword.lower())
current_choice = []
if current_settings_dict.has_key(keyword):
current_choice = current_settings_dict[keyword]
if len(valid_choices) > 0:
entry += '<div class="scrollselect">'
for choice in valid_choices:
selected = ''
if choice in current_choice:
selected = 'checked'
entry += '''
<input type="checkbox" name="%s" %s value="%s">%s<br />''' % \
(keyword, selected, choice, choice)
entry += '</div>'
else:
entry = ''
except:
# failed on evaluating configuration.%s
area = '''
<textarea id="%s" cols=40 rows=1 name="%s">''' % \
(keyword, keyword)
if current_settings_dict.has_key(keyword):
area += '\n'.join(current_settings_dict[keyword])
area += '</textarea>'
entry += wrap_edit_area(keyword, area, general_edit,
'BASIC')
elif val['Type'] == 'string':
# get valid choices from conf
valid_choices = eval('configuration.%s' % keyword.lower())
current_choice = ''
if current_settings_dict.has_key(keyword):
current_choice = current_settings_dict[keyword]
if len(valid_choices) > 0:
entry += '<select name="%s">' % keyword
for choice in valid_choices:
selected = ''
if choice == current_choice:
selected = 'selected'
entry += '<option %s value="%s">%s</option>'\
% (selected, choice, choice)
entry += '</select><br />'
else:
entry = ''
elif val['Type'] == 'boolean':
current_choice = ''
if current_settings_dict.has_key(keyword):
current_choice = current_settings_dict[keyword]
entry += '<select name="%s">' % keyword
for choice in (True, False):
selected = ''
if choice == current_choice:
selected = 'selected'
entry += '<option %s value="%s">%s</option>'\
% (selected, choice, choice)
entry += '</select><br />'
html += """%s
</td></tr>
""" % entry
html += \
"""
<tr><td>
<input type="submit" value="Save General Settings" />
</td></tr>
</table>
</form>
</div>
"""
output_objects.append({'object_type': 'html_form', 'text': html})
if 'job' in topics:
mrsl_path = os.path.join(base_dir, default_mrsl_filename)
default_mrsl = get_default_mrsl(mrsl_path)
html = \
'''
<div id="defaultmrsl">
<form method="post" action="editfile.py">
<table class="defaultjob fixedlayout">
<tr class="title"><td class="centertext">
Default job on submit page
</td></tr>
<tr><td>
</td></tr>
<tr><td>
If you use the same fields and values in many of your jobs, you can save your
preferred job description here to always start out with that description on
your submit job page.
</td></tr>
<tr><td>
</td></tr>
<tr><td>
<input type="hidden" name="path" value="%(mrsl_template)s" />
<input type="hidden" name="newline" value="unix" />
'''
keyword = "defaultjob"
area = '''
<textarea id="%(keyword)s" cols=82 rows=25 name="editarea">
%(default_mrsl)s
</textarea>
'''
html += wrap_edit_area(keyword, area, cm_options, 'BASIC')
html += '''
</td></tr>
<tr><td>
<input type="submit" value="Save Job Template" />
</td></tr>
</table>
</form>
</div>
'''
html = html % {
'default_mrsl': default_mrsl,
'mrsl_template': default_mrsl_filename,
'site': configuration.short_title,
'keyword': keyword
}
output_objects.append({'object_type': 'html_form', 'text': html})
if 'style' in topics:
css_path = os.path.join(base_dir, default_css_filename)
default_css = get_default_css(css_path)
html = \
'''
<div id="defaultcss">
<form method="post" action="editfile.py">
<table class="defaultstyle fixedlayout">
<tr class="title"><td class="centertext">
Default CSS (style) for all pages
</td></tr>
<tr><td>
</td></tr>
<tr><td>
If you want to customize the look and feel of the %(site)s web interfaces you
can override default values here. If you leave the style file blank you will
just use the default style.<br />
You can copy paste from the available style file links below if you want to
override specific parts.<br />
<div class="warningtext">Please note that you can not save an empty style
file, but must at least leave a blank line to use defaults. Additionally some
errors in your style code may potentially cause severe corruption in your page
layouts, so it may be a good idea to keep another browser tab/window ready to
(re)move your .default.css file to restore the defaults while experimenting
here.
</div>
</td></tr>
<tr><td>
<a class="urllink" href="/images/default.css">default</a> ,
<a class="urllink" href="/images/bluesky.css">bluesky</a>
</td></tr>
<tr><td>
</td></tr>
<tr><td>
<input type="hidden" name="path" value="%(css_template)s" />
<input type="hidden" name="newline" value="unix" />
'''
keyword = "defaultstyle"
area = '''
<textarea id="%(keyword)s" cols=82 rows=25 min_len=1 name="editarea">
%(default_css)s
</textarea>
'''
html += wrap_edit_area(keyword, area, style_edit)
html += '''
</td></tr>
<tr><td>
<input type="submit" value="Save Style Settings" />
</td></tr>
</table>
</form>
</div>
'''
html = html % {
'default_css': default_css,
'css_template': default_css_filename,
'site': configuration.short_title,
'keyword': keyword
}
output_objects.append({'object_type': 'html_form', 'text': html})
if 'widgets' in topics:
# load current widgets
current_widgets_dict = load_widgets(client_id, configuration)
if not current_widgets_dict:
# no current widgets found
current_widgets_dict = {}
show_widgets = current_settings_dict.get('ENABLE_WIDGETS', True)
if show_widgets:
edit_widgets = '''You can simply copy/paste from the available
widget file links below if you want to reuse existing widgets.<br />
</td></tr>
<tr><td>
<a class="urllink" href="/images/widgets/hello-grid.app">hello grid</a>,
<a class="urllink" href="/images/widgets/simple-calendar.app">simple calendar</a>,
<a class="urllink" href="/images/widgets/calendar.app">calendar</a>,
<a class="urllink" href="/images/widgets/gcal.app">google calendar</a>,
<a class="urllink" href="/images/widgets/calculator.app">calculator</a>,
<a class="urllink" href="/images/widgets/localrss.app">local rss reader</a>,
<a class="urllink" href="/images/widgets/rss.app">rss reader</a>,
<a class="urllink" href="/images/widgets/clock.app">clock</a>,
<a class="urllink" href="/images/widgets/weather.app">weather</a>,
<a class="urllink" href="/images/widgets/progressbar.app">progress bar</a>,
<a class="urllink" href="/images/widgets/simple-move.app">simple-move</a>,
<a class="urllink" href="/images/widgets/portlets.app">portlets</a>,
<a class="urllink" href="/images/widgets/countdown.app">countdown</a>,
<a class="urllink" href="/images/widgets/sparkline.app">mini chart</a>,
<a class="urllink" href="/images/widgets/piechart.app">pie chart</a>,
<a class="urllink" href="/images/widgets/simple-jobmon.app">simple-jobmon</a>,
<a class="urllink" href="/images/widgets/cert-countdown.app">certificate countdown</a>,
<a class="urllink" href="/images/widgets/disk-use.app">disk use progress bar</a>,
<a class="urllink" href="/images/widgets/jobs-stats.app">jobs stats table</a>,
<a class="urllink" href="/images/widgets/jobs-stats-chart.app">jobs stats chart</a>,
<a class="urllink" href="/images/widgets/daily-wm-comic.app">Daily WulffMorgenthaler comic</a>,
<a class="urllink" href="/images/widgets/kunet-login.app">KUnet login</a>
<a class="urllink" href="/images/widgets/tdchotspot-login.app">TDC Hotspot login</a>
</td></tr>
<tr><td>
<div class="warningtext">Please note that the widgets parser is rather grumpy
so you may have to avoid blank lines in your widget code below. Additionally
any errors in your widgets code may cause severe corruption in your pages, so
it may be a good idea to keep another browser tab/window ready for emergency
disabling of widgets while experimenting here.</div>
</td></tr>
<tr><td>
<input type="hidden" name="topic" value="widgets" />
</td></tr>
<tr><td>
'''
html = \
'''<div id="widgets">
<form method="post" action="settingsaction.py">
<table class="widgets fixedlayout">
<tr class="title"><td class="centertext">
Default user defined widgets for all pages
</td></tr>
<tr><td>
</td></tr>
<tr><td>
If you want to customize the look and feel of the %s web interfaces you can
add your own widgets here. If you leave the widgets blank you will just get
the default empty widget spaces.<br />
''' % configuration.short_title
widgets_entries = get_widgets_specs()
widgets_html = ''
for (keyword, val) in widgets_entries:
widgets_html += \
"""
<tr class=title><td>
%s
</td></tr>
<tr><td>
%s
</td></tr>
<tr><td>
"""\
% (keyword.replace('_', ' ').title(), val['Description'])
if val['Type'] == 'multiplestrings':
try:
# get valid choices from conf. multiple selections
valid_choices = eval('configuration.%s' % keyword.lower())
current_choice = []
if current_widgets_dict.has_key(keyword):
current_choice = current_widgets_dict[keyword]
if len(valid_choices) > 0:
widgets_html += '<div class="scrollselect">'
for choice in valid_choices:
selected = ''
if choice in current_choice:
selected = 'checked'
widgets_html += '''
<input type="checkbox" name="%s" %s value="%s">%s<br />'''\
% (keyword, selected, choice, choice)
widgets_html += '</div>'
except:
area = \
"""<textarea id='%s' cols=78 rows=10 name='%s'>""" % \
(keyword, keyword)
if current_widgets_dict.has_key(keyword):
area += '\n'.join(current_widgets_dict[keyword])
area += '</textarea>'
widgets_html += wrap_edit_area(keyword, area, widgets_edit)
if show_widgets:
edit_widgets += '''
%s
<tr><td>
<input type="submit" value="Save Widgets Settings" />
</td></tr>
''' % widgets_html
else:
edit_widgets = '''
<br/>
<div class="warningtext">
Widgets are disabled on your <em>General</em> settings page. Please enable
them there first if you want to customize your grid pages.
</div>
'''
html += \
'''
%s
</table>
</form>
</div>
''' % edit_widgets
output_objects.append({'object_type': 'html_form', 'text': html})
if 'profile' in topics:
# load current profile
current_profile_dict = load_profile(client_id, configuration)
if not current_profile_dict:
# no current profile found
current_profile_dict = {}
(got_list, all_vgrids) = vgrid_list_vgrids(configuration)
if not got_list:
all_vgrids = []
all_vgrids.append(any_vgrid)
all_vgrids.sort()
configuration.vgrids_allow_email = all_vgrids
configuration.vgrids_allow_im = all_vgrids
images = []
for path in os.listdir(base_dir):
real_path = os.path.join(base_dir, path)
if os.path.splitext(path)[1].strip('.') in profile_img_extensions \
and os.path.getsize(real_path) < profile_img_max_kb*1024:
images.append(path)
configuration.public_image = images
html = \
'''
<div id="profile">
<form method="post" action="settingsaction.py">
<table class="profile fixedlayout">
<tr class="title"><td class="centertext">
Public profile information visible to other users.
</td></tr>
<tr><td>
</td></tr>
<tr><td>
If you want to let other users know more about you can add your own text here.
If you leave the text area blank you will just get the default empty profile
information.<br />
</td></tr>
<tr><td>
<div class="warningtext">Please note that the profile parser is rather grumpy
so you may have to avoid blank lines in your text below.
</div>
</td></tr>
<tr><td>
<input type="hidden" name="topic" value="profile" />
</td></tr>
<tr><td>
'''
profile_entries = get_profile_specs()
for (keyword, val) in profile_entries:
# Mask VGrid name if configured
mask_title = keyword.replace(
'VGRID', configuration.site_vgrid_label.upper())
mask_desc = val['Description'].replace(
'VGrid', configuration.site_vgrid_label)
html += \
"""
<tr class=title><td>
%s
</td></tr>
<tr><td>
%s
</td></tr>
<tr><td>
""" % (mask_title.replace('_', ' ').title(),
html_escape(mask_desc))
if val['Type'] == 'multiplestrings':
try:
# get valid choices from conf. multiple selections
valid_choices = eval('configuration.%s' % keyword.lower())
current_choice = []
if current_profile_dict.has_key(keyword):
current_choice = current_profile_dict[keyword]
if len(valid_choices) > 0:
html += '<div class="scrollselect">'
for choice in valid_choices:
selected = ''
if choice in current_choice:
selected = 'checked'
html += '''
<input type="checkbox" name="%s" %s value="%s">%s<br />''' % \
(keyword, selected, choice, choice)
html += '</div>'
except:
area = \
"""<textarea id='%s' cols=78 rows=10 name='%s'>""" % \
(keyword, keyword)
if current_profile_dict.has_key(keyword):
area += '\n'.join(current_profile_dict[keyword])
area += '</textarea>'
html += wrap_edit_area(keyword, area, profile_edit)
elif val['Type'] == 'boolean':
valid_choices = [True, False]
current_choice = ''
if current_profile_dict.has_key(keyword):
current_choice = current_profile_dict[keyword]
if len(valid_choices) > 0:
html += '<select name="%s">' % keyword
for choice in valid_choices:
selected = ''
if choice == current_choice:
selected = 'selected'
html += '<option %s value="%s">%s</option>'\
% (selected, choice, choice)
html += '</select><br />'
html += '''
<tr><td>
<input type="submit" value="Save Profile Settings" />
</td></tr>
</table>
</form>
</div>
'''
output_objects.append({'object_type': 'html_form', 'text': html})
if 'sftp' in topics:
# load current ssh/sftp
current_ssh_dict = load_ssh(client_id, configuration)
if not current_ssh_dict:
# no current ssh found
current_ssh_dict = {}
default_authkeys = current_ssh_dict.get('authkeys', '')
default_authpassword = current_ssh_dict.get('authpassword', '')
username = client_alias(client_id)
if configuration.user_sftp_alias:
username = extract_field(client_id, configuration.user_sftp_alias)
create_alias_link(username, client_id, configuration.user_home)
sftp_server = configuration.user_sftp_show_address
sftp_port = configuration.user_sftp_show_port
html = \
'''
<div id="sshaccess">
<form method="post" action="settingsaction.py">
<table class="sshsettings fixedlayout">
<tr class="title"><td class="centertext">
SFTP access to your %(site)s account
</td></tr>
<tr><td>
</td></tr>
<tr><td>
You can configure SFTP login to your %(site)s account for efficient file
access. On Linux/UN*X it also allows transparent access through SSHFS.
<br/>
<h3>Login Details</h3>
<ul>
<li>Host <em>%(sftp_server)s</em></li>
<li>Port <em>%(sftp_port)s</em></li>
<li>Username <em>%(username)s</em></li>
<li>%(auth_methods)s <em>as you choose below</em></li>
</ul>
</td></tr>
<tr><td>
<input type="hidden" name="topic" value="sftp" />
<div class="div-sftp-client-notes hidden">
<a href="javascript:toggleHidden('.div-sftp-client-notes');"
class="removeitemlink" title="Toggle view">
Show less SFTP client details...</a>
<h3>Graphical SFTP access</h3>
The FireFTP plugin for Firefox is known to generally work for graphical
access to your %(site)s home over SFTP.
Enter the following values in the FireFTP Account Manager:
<pre>
Host %(sftp_server)s
Login %(username)s
Password YOUR_PASSWORD_HERE (passphrase if you configured public key access)
Security SFTP
Port %(sftp_port)s
Private Key ~/.mig/key.pem (if you configured public key access)
</pre>
other graphical clients may work as well.
<h3>Command line SFTP/SSHFS access on Linux/UN*X</h3>
Save something like the following lines in your local ~/.ssh/config
to avoid typing the full login details every time:<br />
<pre>
Host %(sftp_server)s
Hostname %(sftp_server)s
User %(username)s
Port %(sftp_port)s
IdentityFile ~/.mig/key.pem
</pre>
From then on you can use sftp and sshfs to access your %(site)s home:
<pre>
sftp %(sftp_server)s
</pre>
<pre>
sshfs %(sftp_server)s: mig-home -o uid=$(id -u) -o gid=$(id -g)
</pre>
You can also integrate with ordinary mounts by adding a line like:
<pre>
sshfs#%(username)s@%(sftp_server)s: /home/USER/mig-home fuse noauto,user,port=%(sftp_port)d 0 0
</pre>
to your /etc/fstab .
</div>
<div class="div-sftp-client-notes">
<a href="javascript:toggleHidden('.div-sftp-client-notes');"
class="additemlink" title="Toggle view">Show more SFTP client details...
</a>
</div>
'''
keyword_keys = "authkeys"
if 'publickey' in configuration.user_sftp_auth:
html += '''
</td></tr>
<tr><td>
<h3>Authorized Public Keys</h3>
You can use any existing RSA key, or create a new one. If you signed up with a
x509 user certificate, you should also have received such a key.pem along with
your user certificate. In any case you need to save the contents of the
corresponding public key (X.pub) in the text area below, to be able to connect
with username and key as described in the Login Details.
<br/>
'''
area = '''
<textarea id="%(keyword_keys)s" cols=82 rows=5 name="publickeys">
%(default_authkeys)s
</textarea>
'''
html += wrap_edit_area(keyword_keys, area, ssh_edit, 'BASIC')
html += '''
(leave empty to disable sftp access with public keys)
</td></tr>
'''
keyword_password = "******"
if 'password' in configuration.user_sftp_auth:
# We only want a single password and a masked input field
html += '''
<tr><td>
<h3>Authorized Password</h3>
Please enter and save your desired password in the text field below, to be able
to connect with username and password as described in the Login Details.
<br/>
<input type=password id="%(keyword_password)s" size=40 name="password"
value="%(default_authpassword)s" />
(leave empty to disable sftp access with password)
</td></tr>
'''
html += '''
<tr><td>
<input type="submit" value="Save SFTP Settings" />
</td></tr>
'''
html += '''
</table>
</form>
</div>
'''
html = html % {
'default_authkeys': default_authkeys,
'default_authpassword': default_authpassword,
'site': configuration.short_title,
'keyword_keys': keyword_keys,
'keyword_password': keyword_password,
'username': username,
'sftp_server': sftp_server,
'sftp_port': sftp_port,
'auth_methods': ' / '.join(configuration.user_sftp_auth).title(),
}
output_objects.append({'object_type': 'html_form', 'text': html})
if 'webdavs' in topics:
# load current davs
current_davs_dict = load_davs(client_id, configuration)
if not current_davs_dict:
# no current davs found
current_davs_dict = {}
default_authkeys = current_davs_dict.get('authkeys', '')
default_authpassword = current_davs_dict.get('authpassword', '')
username = client_alias(client_id)
if configuration.user_davs_alias:
username = extract_field(client_id, configuration.user_davs_alias)
create_alias_link(username, client_id, configuration.user_home)
davs_server = configuration.user_davs_show_address
davs_port = configuration.user_davs_show_port
html = \
'''
<div id="davsaccess">
<form method="post" action="settingsaction.py">
<table class="davssettings fixedlayout">
<tr class="title"><td class="centertext">
WebDAVS access to your %(site)s account
</td></tr>
<tr><td>
</td></tr>
<tr><td>
You can configure WebDAVS login to your %(site)s account for transparent file
access from your PC or workstation.<br/>
<h3>Login Details</h3>
<ul>
<li>Host <em>%(davs_server)s</em></li>
<li>Port <em>%(davs_port)s</em></li>
<li>Username <em>%(username)s</em></li>
<li>%(auth_methods)s <em>as you choose below</em></li>
</ul>
</td></tr>
<tr><td>
<input type="hidden" name="topic" value="webdavs" />
<div class="div-webdavs-client-notes hidden">
<a href="javascript:toggleHidden('.div-webdavs-client-notes');"
class="removeitemlink" title="Toggle view">
Show less WebDAVS client details...</a>
<h3>Graphical WebDAVS access</h3>
Several native file browsers and web browsers are known to generally work for
graphical access to your %(site)s home over WebDAVS.
<br />
Enter the address https://%(davs_server)s:%(davs_port)s and when fill in the
login details:
<pre>
Username %(username)s
Password YOUR_PASSWORD_HERE
</pre>
other graphical clients should work as well.
<h3>Command line WebDAVS access on Linux/UN*X</h3>
Save something like the following lines in your local ~/.netrc
to avoid typing the full login details every time:<br />
<pre>
machine %(davs_server)s
login %(username)s
password YOUR_PASSWORD_HERE
</pre>
From then on you can use e.g. cadaver or fusedav to access your %(site)s home:
<pre>
cadaver https://%(davs_server)s:%(davs_port)s
</pre>
<pre>
fusedav https://%(davs_server)s:%(davs_port)s mig-home -o uid=$(id -u) -o gid=$(id -g)
</pre>
</div>
<div class="div-webdavs-client-notes">
<a href="javascript:toggleHidden('.div-webdavs-client-notes');"
class="additemlink" title="Toggle view">
Show more WebDAVS client details...</a>
</div>
'''
keyword_keys = "authkeys"
if 'publickey' in configuration.user_davs_auth:
html += '''
</td></tr>
<tr><td>
<h3>Authorized Public Keys</h3>
You can use any existing RSA key, including the key.pem you received along with
your user certificate, or create a new one. In any case you need to save the
contents of the corresponding public key (X.pub) in the text area below, to be
able to connect with username and key as described in the Login Details.
<br/>'''
area = '''
<textarea id="%(keyword_keys)s" cols=82 rows=5 name="publickeys">
%(default_authkeys)s
</textarea>
'''
html += wrap_edit_area(keyword_keys, area, davs_edit, 'BASIC')
html += '''
(leave empty to disable davs access with public keys)
</td></tr>
'''
keyword_password = "******"
if 'password' in configuration.user_davs_auth:
# We only want a single password and a masked input field
html += '''
<tr><td>
<h3>Authorized Password</h3>
Please enter and save your desired password in the text field below, to be able
to connect with username and password as described in the Login Details.
<br/>
<input type=password id="%(keyword_password)s" size=40 name="password"
value="%(default_authpassword)s" />
(leave empty to disable davs access with password)
</td></tr>
'''
html += '''
<tr><td>
<input type="submit" value="Save WebDAVS Settings" />
</td></tr>
'''
html += '''
</table>
</form>
</div>
'''
html = html % {
'default_authkeys': default_authkeys,
'default_authpassword': default_authpassword,
'site': configuration.short_title,
'keyword_keys': keyword_keys,
'keyword_password': keyword_password,
'username': username,
'davs_server': davs_server,
'davs_port': davs_port,
'auth_methods': ' / '.join(configuration.user_davs_auth).title(),
}
output_objects.append({'object_type': 'html_form', 'text': html})
if 'ftps' in topics:
# load current ftps
current_ftps_dict = load_ftps(client_id, configuration)
if not current_ftps_dict:
# no current ftps found
current_ftps_dict = {}
default_authkeys = current_ftps_dict.get('authkeys', '')
default_authpassword = current_ftps_dict.get('authpassword', '')
username = client_alias(client_id)
if configuration.user_ftps_alias:
username = extract_field(client_id, configuration.user_ftps_alias)
create_alias_link(username, client_id, configuration.user_home)
ftps_server = configuration.user_ftps_show_address
ftps_ctrl_port = configuration.user_ftps_show_ctrl_port
html = \
'''
<div id="ftpsaccess">
<form method="post" action="settingsaction.py">
<table class="ftpssettings fixedlayout">
<tr class="title"><td class="centertext">
FTPS access to your %(site)s account
</td></tr>
<tr><td>
</td></tr>
<tr><td>
You can configure FTPS login to your %(site)s account for efficient file
access.<br/>
<h3>Login Details</h3>
<ul>
<li>Host <em>%(ftps_server)s</em></li>
<li>Port <em>%(ftps_ctrl_port)s</em></li>
<li>Username <em>%(username)s</em></li>
<li>%(auth_methods)s <em>as you choose below</em></li>
</ul>
</td></tr>
<tr><td>
<input type="hidden" name="topic" value="ftps" />
<div class="div-ftps-client-notes hidden">
<a href="javascript:toggleHidden('.div-ftps-client-notes');"
class="removeitemlink" title="Toggle view">
Show less FTPS client details...</a>
<h3>Graphical FTPS access</h3>
The FireFTP plugin for Firefox is known to generally work for graphical
access to your %(site)s home over FTPS.
Enter the following values in the FireFTP Account Manager:
<pre>
Host %(ftps_server)s
Login %(username)s
Password YOUR_PASSWORD_HERE
Security FTPS
Port %(ftps_ctrl_port)s
</pre>
Other FTP clients and web browsers may work as well if you enter the address
ftps://%(ftps_server)s:%(ftps_ctrl_port)s
and fill in the login details when prompted:
<pre>
Username %(username)s
Password YOUR_PASSWORD_HERE
</pre>
<h3>Command line FTPS access on Linux/UN*X</h3>
Save something like the following lines in your local ~/.netrc
to avoid typing the full login details every time:<br />
<pre>
machine %(ftps_server)s
login %(username)s
password YOUR_PASSWORD_HERE
</pre>
From then on you can use e.g. lftp or CurlFtpFS to access your %(site)s home:
<!--
TODO: we need to provide the intermediate cert for server cert check like this
set ssl:ca-file sub.class1.server.ca.pem
-->
<pre>
lftp -e "set ssl:verify-certificate no; set ftp:ssl-protect-data on" \\
-p %(ftps_ctrl_port)s %(ftps_server)s
</pre>
<pre>
curlftpfs -o ssl %(ftps_server)s:%(ftps_ctrl_port)s mig-home \\
-o user=%(username)s -ouid=$(id -u) -o gid=$(id -g) -o no_verify_peer
</pre>
</div>
<div class="div-ftps-client-notes">
<a href="javascript:toggleHidden('.div-ftps-client-notes');"
class="additemlink" title="Toggle view">Show more FTPS client details...
</a>
</div>
'''
keyword_keys = "authkeys"
if 'publickey' in configuration.user_ftps_auth:
html += '''
</td></tr>
<tr><td>
<h3>Authorized Public Keys</h3>
You can use any existing RSA key, including the key.pem you received along with
your user certificate, or create a new one. In any case you need to save the
contents of the corresponding public key (X.pub) in the text area below, to be
able to connect with username and key as described in the Login Details.
<br/>
'''
area = '''
<textarea id="%(keyword_keys)s" cols=82 rows=5 name="publickeys">
%(default_authkeys)s
</textarea>
'''
html += wrap_edit_area(keyword_keys, area, ftps_edit, 'BASIC')
html += '''
(leave empty to disable ftps access with public keys)
</td></tr>
'''
keyword_password = "******"
if 'password' in configuration.user_ftps_auth:
# We only want a single password and a masked input field
html += '''
<tr><td>
<h3>Authorized Password</h3>
Please enter and save your desired password in the text field below, to be able
to connect with username and password as described in the Login Details.
<br/>
<input type=password id="%(keyword_password)s" size=40 name="password"
value="%(default_authpassword)s" />
(leave empty to disable ftps access with password)
</td></tr>
'''
html += '''
<tr><td>
<input type="submit" value="Save FTPS Settings" />
</td></tr>
'''
html += '''
</table>
</form>
</div>
'''
html = html % {
'default_authkeys': default_authkeys,
'default_authpassword': default_authpassword,
'site': configuration.short_title,
'keyword_keys': keyword_keys,
'keyword_password': keyword_password,
'username': username,
'ftps_server': ftps_server,
'ftps_ctrl_port': ftps_ctrl_port,
'auth_methods': ' / '.join(configuration.user_ftps_auth).title(),
}
output_objects.append({'object_type': 'html_form', 'text': html})
# if ARC-enabled server:
if 'arc' in topics:
# provide information about the available proxy, offer upload
try:
home_dir = os.path.normpath(base_dir)
session_Ui = arc.Ui(home_dir, require_user_proxy=True)
proxy = session_Ui.getProxy()
if proxy.IsExpired():
# can rarely happen, constructor will throw exception
output_objects.append({'object_type': 'text',
'text': 'Proxy certificate is expired.'})
else:
output_objects.append({'object_type': 'text',
'text': 'Proxy for %s' \
% proxy.GetIdentitySN()})
output_objects.append(
{'object_type': 'text',
'text': 'Proxy certificate will expire on %s (in %s sec.)'
% (proxy.Expires(), proxy.getTimeleft())
})
except arc.NoProxyError, err:
output_objects.append({'object_type':'warning',
'text': 'No proxy certificate to load: %s' \
% err.what()})
output_objects = output_objects + arc.askProxy()
def initialize_main_variables(client_id,
op_title=True,
op_header=True,
op_menu=True):
"""Script initialization is identical for most scripts in
shared/functionalty. This function should be called in most cases.
"""
configuration = get_configuration_object()
logger = configuration.logger
output_objects = []
start_entry = make_start_entry()
output_objects.append(start_entry)
op_name = os.path.splitext(os.path.basename(requested_page()))[0]
if op_title:
skipwidgets = not configuration.site_enable_widgets or not client_id
skipuserstyle = not configuration.site_enable_styling or not client_id
title_object = make_title_entry('%s' % op_name,
skipmenu=(not op_menu),
skipwidgets=skipwidgets,
skipuserstyle=skipuserstyle,
skipuserprofile=(not client_id))
# Make sure base_menu is always set for extract_menu
# Typicall overriden based on client_id cases below
title_object['base_menu'] = configuration.site_default_menu
output_objects.append(title_object)
if op_header:
header_object = make_header_entry('%s' % op_name)
output_objects.append(header_object)
if client_id:
# add the user-defined menu and widgets (if possible)
title = find_entry(output_objects, 'title')
if title:
settings = load_settings(client_id, configuration)
# NOTE: loaded settings may be False rather than dict here
if not settings:
settings = {}
title['style'] = themed_styles(configuration,
user_settings=settings)
title['script'] = themed_scripts(configuration,
user_settings=settings)
if settings:
title['user_settings'] = settings
base_menu = settings.get('SITE_BASE_MENU', 'default')
if not base_menu in configuration.site_base_menu:
base_menu = 'default'
if base_menu == 'simple' and configuration.site_simple_menu:
title['base_menu'] = configuration.site_simple_menu
elif base_menu == 'advanced' and \
configuration.site_advanced_menu:
title['base_menu'] = configuration.site_advanced_menu
else:
title['base_menu'] = configuration.site_default_menu
user_menu = settings.get('SITE_USER_MENU', None)
if configuration.site_user_menu and user_menu:
title['user_menu'] = user_menu
if settings.get('ENABLE_WIDGETS', True) and \
configuration.site_script_deps:
user_widgets = load_widgets(client_id, configuration)
if user_widgets:
title['user_widgets'] = user_widgets
user_profile = load_profile(client_id, configuration)
if user_profile:
# These data are used for display in own profile view only
profile_image_list = user_profile.get('PUBLIC_IMAGE', [])
if profile_image_list:
# TODO: copy profile image to /public/avatars/X and use it
profile_image = os.path.join(
configuration.site_user_redirect,
profile_image_list[-1])
else:
profile_image = ''
user_profile['profile_image'] = profile_image
else:
user_profile = {}
# Always set full name for use in personal user menu
full_name = extract_field(client_id, 'full_name')
user_profile['full_name'] = full_name
title['user_profile'] = user_profile
logger.debug('setting user profile: %s' % user_profile)
else:
# No user so we just enforce default site style and scripts
title = find_entry(output_objects, 'title')
if title:
title['style'] = themed_styles(configuration)
title['script'] = themed_scripts(configuration, logged_in=False)
return (configuration, logger, output_objects, op_name)
