mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
124 lines
4.0 KiB
Python
124 lines
4.0 KiB
Python
#
|
|
# This file is part of Plinth.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
"""
|
|
Plinth module to configure Roundcube.
|
|
"""
|
|
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from plinth import actions
|
|
from plinth import action_utils
|
|
from plinth import cfg
|
|
from plinth import frontpage
|
|
from plinth import service as service_module
|
|
|
|
|
|
version = 1
|
|
|
|
depends = ['apps']
|
|
|
|
managed_packages = ['sqlite3', 'roundcube', 'roundcube-sqlite3']
|
|
|
|
title = _('Email Client (Roundcube)')
|
|
|
|
description = [
|
|
_('Roundcube webmail is a browser-based multilingual IMAP '
|
|
'client with an application-like user interface. It provides '
|
|
'full functionality you expect from an email client, including '
|
|
'MIME support, address book, folder manipulation, message '
|
|
'searching and spell checking.'),
|
|
|
|
_('You can access Roundcube from <a href="/roundcube">'
|
|
'/roundcube</a>. Provide the username and password of the email '
|
|
'account you wish to access followed by the domain name of the '
|
|
'IMAP server for your email provider, like <code>imap.example.com'
|
|
'</code>. For IMAP over SSL (recommended), fill the server field '
|
|
'like <code>imaps://imap.example.com</code>.'),
|
|
|
|
_('For Gmail, username will be your Gmail address, password will be '
|
|
'your Google account password and server will be '
|
|
'<code>imaps://imap.gmail.com</code>. Note that you will also need '
|
|
'to enable "Less secure apps" in your Google account settings '
|
|
'(<a href="https://www.google.com/settings/security/lesssecureapps"'
|
|
'>https://www.google.com/settings/security/lesssecureapps</a>).'),
|
|
]
|
|
|
|
service = None
|
|
|
|
|
|
def init():
|
|
"""Intialize the module."""
|
|
menu = cfg.main_menu.get('apps:index')
|
|
menu.add_urlname(title, 'glyphicon-envelope', 'roundcube:index')
|
|
|
|
global service
|
|
setup_helper = globals()['setup_helper']
|
|
if setup_helper.get_state() != 'needs-setup':
|
|
service = service_module.Service(
|
|
'roundcube', title, ports=['http', 'https'], is_external=True,
|
|
is_enabled=is_enabled, enable=enable, disable=disable)
|
|
|
|
if is_enabled():
|
|
add_shortcut()
|
|
|
|
|
|
def setup(helper, old_version=None):
|
|
"""Install and configure the module."""
|
|
helper.call('pre', actions.superuser_run, 'roundcube', ['pre-install'])
|
|
helper.install(managed_packages)
|
|
helper.call('post', actions.superuser_run, 'roundcube', ['setup'])
|
|
helper.call('post', add_shortcut)
|
|
global service
|
|
if service is None:
|
|
service = service_module.Service(
|
|
'roundcube', title, ports=['http', 'https'], is_external=True,
|
|
is_enabled=is_enabled, enable=enable, disable=disable)
|
|
|
|
|
|
def add_shortcut():
|
|
frontpage.add_shortcut(
|
|
'roundcube', title, '/roundcube', 'glyphicon-envelope',
|
|
login_required=True)
|
|
|
|
|
|
def is_enabled():
|
|
"""Return whether the module is enabled."""
|
|
return action_utils.webserver_is_enabled('roundcube')
|
|
|
|
|
|
def enable():
|
|
"""Enable the module."""
|
|
actions.superuser_run('roundcube', ['enable'])
|
|
add_shortcut()
|
|
|
|
|
|
def disable():
|
|
"""Enable the module."""
|
|
actions.superuser_run('roundcube', ['disable'])
|
|
frontpage.remove_shortcut('roundcube')
|
|
|
|
|
|
def diagnose():
|
|
"""Run diagnostics and return the results."""
|
|
results = []
|
|
|
|
results.extend(action_utils.diagnose_url_on_all(
|
|
'https://{host}/roundcube', check_certificate=False))
|
|
|
|
return results
|