Inital commit for Rainloop to replace Roundcube

conf/nginx-alldomains.conf

@@ -19,14 +19,14 @@
 		alias /var/lib/mailinabox/mozilla-autoconfig.xml;
 	}
 
-	# Roundcube Webmail configuration.
+	# Rainloop Webmail configuration.
 	rewrite ^/mail$ /mail/ redirect;
 	rewrite ^/mail/$ /mail/index.php;
 	location /mail/ {
 		index index.php;
-		alias /usr/local/lib/roundcubemail/;
+		alias /usr/local/lib/rainloop/;
 	}
-	location ~ /mail/config/.* {
+	location ~ /mail/data/.* {
 		# A ~-style location is needed to give this precedence over the next block.
 		return 403;
 	}
@@ -35,7 +35,7 @@
 		include fastcgi_params;
 		fastcgi_split_path_info ^/mail(/.*)()$;
 		fastcgi_index index.php;
-		fastcgi_param SCRIPT_FILENAME /usr/local/lib/roundcubemail/$fastcgi_script_name;
+		fastcgi_param SCRIPT_FILENAME /usr/local/lib/rainloop/$fastcgi_script_name;
 		fastcgi_pass php-fpm;
 
 		# Outgoing mail also goes through this endpoint, so increase the maximum

setup/webmail.sh

@@ -5,23 +5,18 @@
 source setup/functions.sh # load our functions
 source /etc/mailinabox.conf # load global vars
 
-# ### Installing Roundcube
+# ### Installing Roundloop
 
-# We install Roundcube from sources, rather than from Ubuntu, because:
+# Roundloop's webpage (http://www.rainloop.net/downloads/) does not easily	#
-#
+# list versions as the need for VERSION_FILENAME below. 			#
-# 1. Ubuntu's `roundcube-core` package has dependencies on Apache & MySQL, which we don't want.
-#
-# 2. The Roundcube shipped with Ubuntu is consistently out of date.
-#
-# 3. It's packaged incorrectly --- it seems to be missing a directory of files.
-#
-# So we'll use apt-get to manually install the dependencies of roundcube that we know we need,
-# and then we'll manually install roundcube from source.
 
-# These dependencies are from `apt-cache showpkg roundcube-core`.
+# 
-echo "Installing Roundcube (webmail)..."
+# Dependancies are from Roundcube, not all may be needed for Rainloop		#
+
+echo "Installing Rainloop (webmail)..."
 apt_install \
 	dbconfig-common \
+	unzip \
 	php5 php5-sqlite php5-mcrypt php5-intl php5-json php5-common php-auth php-net-smtp php-net-socket php-net-sieve php-mail-mime php-crypt-gpg php5-gd php5-pspell \
 	tinymce libjs-jquery libjs-jquery-mousewheel libmagic1
 apt_get_quiet remove php-mail-mimedecode # no longer needed since Roundcube 1.1.3
@@ -34,14 +29,12 @@ apt-get purge -qq -y roundcube* #NODOC
 # Install Roundcube from source if it is not already present or if it is out of date.
 # Combine the Roundcube version number with the commit hash of vacation_sieve to track
 # whether we have the latest version.
-VERSION=1.2.0
+VERSION=v1.10.1.127
-HASH=2088985fb613b4e4e3373933ca44b26fce0489fb
+VERSION_FILENAME="rainloop-community-1.10.1.127-18d553ae9cd96eb102059b04fdee62e0.zip"
-VACATION_SIEVE_VERSION=91ea6f52216390073d1f5b70b5f6bea0bfaee7e5
+HASH=bf2b42c99a6d8be151e2c1dc3442604ca709e1ba
-PERSISTENT_LOGIN_VERSION=1e9d724476a370ce917a2fcd5b3217b0c306c24e
+UPDATE_KEY=$VERSION:a
-HTML5_NOTIFIER_VERSION=4b370e3cd60dabd2f428a26f45b677ad1b7118d5
-UPDATE_KEY=$VERSION:$VACATION_SIEVE_VERSION:$PERSISTENT_LOGIN_VERSION:$HTML5_NOTIFIER_VERSION:a
 needs_update=0 #NODOC
-if [ ! -f /usr/local/lib/roundcubemail/version ]; then
+if [ ! -f /usr/local/lib/rainloop/version ]; then
 	# not installed yet #NODOC
 	needs_update=1 #NODOC
 elif [[ "$UPDATE_KEY" != `cat /usr/local/lib/roundcubemail/version` ]]; then
@@ -49,120 +42,437 @@ elif [[ "$UPDATE_KEY" != `cat /usr/local/lib/roundcubemail/version` ]]; then
 	needs_update=1 #NODOC
 fi
 if [ $needs_update == 1 ]; then
-	# install roundcube
+	# install rainloop
 	wget_verify \
-		https://github.com/roundcube/roundcubemail/releases/download/$VERSION/roundcubemail-$VERSION.tar.gz \
+		https://github.com/RainLoop/rainloop-webmail/releases/download/$VERSION/$VERSION_FILENAME \
 		$HASH \
-		/tmp/roundcube.tgz
+		/tmp/rainloop.zip
-	tar -C /usr/local/lib --no-same-owner -zxf /tmp/roundcube.tgz
+	# Per documentation, updates can overwrite existing files
-	rm -rf /usr/local/lib/roundcubemail
+	unzip -q -o /tmp/rainloop.zip -d /usr/local/lib/rainloop
-	mv /usr/local/lib/roundcubemail-$VERSION/ /usr/local/lib/roundcubemail
+	rm -f /tmp/rainloop.zip
-	rm -f /tmp/roundcube.tgz
 
-	# install roundcube autoreply/vacation plugin
-	git_clone https://github.com/arodier/Roundcube-Plugins.git $VACATION_SIEVE_VERSION plugins/vacation_sieve /usr/local/lib/roundcubemail/plugins/vacation_sieve
-
-	# install roundcube persistent_login plugin
-	git_clone https://github.com/mfreiholz/Roundcube-Persistent-Login-Plugin.git $PERSISTENT_LOGIN_VERSION '' /usr/local/lib/roundcubemail/plugins/persistent_login
-
-	# install roundcube html5_notifier plugin
-	git_clone https://github.com/kitist/html5_notifier.git $HTML5_NOTIFIER_VERSION '' /usr/local/lib/roundcubemail/plugins/html5_notifier
 
 	# record the version we've installed
-	echo $UPDATE_KEY > /usr/local/lib/roundcubemail/version
+	echo $UPDATE_KEY > /usr/local/lib/rainloop/version
 fi
 
-# ### Configuring Roundcube
+# ### Configuring Rainloop
-
-# Generate a safe 24-character secret key of safe characters.
-SECRET_KEY=$(dd if=/dev/urandom bs=1 count=18 2>/dev/null | base64 | fold -w 24 | head -n 1)
 
 # Create a configuration file.
 #
-# For security, temp and log files are not stored in the default locations
+
-# which are inside the roundcube sources directory. We put them instead
+# Some application paths are not created until the application is launched
-# in normal places.
+# this should include the internal process it has when upgrading between versions
-cat > /usr/local/lib/roundcubemail/config/config.inc.php <<EOF;
+
-<?php
+# Fix permissions
-/*
+find /usr/local/lib/rainloop -type d -exec chmod 755 {} \;
- * Do not edit. Written by Mail-in-a-Box. Regenerated on updates.
+find /usr/local/lib/rainloop -type f -exec chmod 644 {} \;
- */
+chown -R www-data:www-data /usr/local/lib/rainloop
-\$config = array();
+
-\$config['log_dir'] = '/var/log/roundcubemail/';
+# Fixing permissions needs to happen first or else curl gets
-\$config['temp_dir'] = '/tmp/roundcubemail/';
+# this error: [105] Missing version directory
-\$config['db_dsnw'] = 'sqlite:///$STORAGE_ROOT/mail/roundcube/roundcube.sqlite?mode=0640';
+
-\$config['default_host'] = 'ssl://localhost';
+curl -s -L https://$PRIMARY_HOSTNAME/mail/ > /dev/null
-\$config['default_port'] = 993;
+
-\$config['imap_timeout'] = 15;
+
-\$config['smtp_server'] = 'tls://127.0.0.1';
+# Set customized configuration
-\$config['smtp_port'] = 587;
+# Rainloop has a default password set, not sure yet how to integrate with userlist
-\$config['smtp_user'] = '%u';
+# for now we should change it from the default
-\$config['smtp_pass'] = '%p';
+# Methods for changing password: https://github.com/RainLoop/rainloop-webmail/issues/28
-\$config['support_url'] = 'https://mailinabox.email/';
+#
-\$config['product_name'] = '$PRIMARY_HOSTNAME Webmail';
+# Untested: edit admin_password = "????" below
-\$config['des_key'] = '$SECRET_KEY';
+#
-\$config['plugins'] = array('html5_notifier', 'archive', 'zipdownload', 'password', 'managesieve', 'jqueryui', 'vacation_sieve', 'persistent_login');
+#	or use the Rainloop API:
-\$config['skin'] = 'classic';
+#	<?php
-\$config['login_autocomplete'] = 2;
+#
-\$config['password_charset'] = 'UTF-8';
+#	$_ENV['RAINLOOP_INCLUDE_AS_API'] = true;
-\$config['junk_mbox'] = 'Spam';
+#	include '<path-to-rainloop-folder>/index.php';
-?>
+#
+#	$oConfig = \RainLoop\Api::Config();
+#	$oConfig->SetPassword('pa$$wOrd');
+#	echo $oConfig->Save() ? 'Done' : 'Error';
+#
+#	?>
+
+# This can be improved, need to take a look at editconf.py for multi line edits as
+# there are multiple "enable = On" but we should only edit them per category.
+
+cat > /usr/local/lib/rainloop/data/_data_/_default_/configs/application.ini <<EOF;
+; RainLoop Webmail configuration file
+; Please don't add custom parameters here, those will be overwritten
+
+[webmail]
+; Text displayed as page title
+title = "RainLoop Webmail"
+
+; Text displayed on startup
+loading_description = "RainLoop"
+favicon_url = ""
+
+; Theme used by default
+theme = "Default"
+
+; Allow theme selection on settings screen
+allow_themes = On
+allow_user_background = Off
+
+; Language used by default
+language = "en"
+
+; Admin Panel interface language
+language_admin = "en"
+
+; Allow language selection on settings screen
+allow_languages_on_settings = On
+allow_additional_accounts = On
+allow_additional_identities = On
+
+;  Number of messages displayed on page by default
+messages_per_page = 20
+
+; File size limit (MB) for file upload on compose screen
+; 0 for unlimited.
+attachment_size_limit = 25
+
+[interface]
+show_attachment_thumbnail = On
+use_native_scrollbars = Off
+
+[branding]
+login_logo = ""
+login_background = ""
+login_desc = ""
+login_css = ""
+login_powered = On
+user_css = ""
+user_logo = ""
+user_logo_title = ""
+user_logo_message = ""
+user_iframe_message = ""
+welcome_page_url = ""
+welcome_page_display = "none"
+
+[contacts]
+; Enable contacts
+enable = On
+allow_sharing = On
+allow_sync = On
+sync_interval = 20
+type = "sqlite"
+pdo_dsn = "mysql:host=127.0.0.1;port=3306;dbname=rainloop"
+pdo_user = "root"
+pdo_password = ""
+suggestions_limit = 30
+
+[security]
+; Enable CSRF protection (http://en.wikipedia.org/wiki/Cross-site_request_forgery)
+csrf_protection = On
+custom_server_signature = "RainLoop"
+x_frame_options_header = ""
+openpgp = Off
+openpgp_public_key_server = ""
+use_rsa_encryption = Off
+
+; Login and password for web admin panel
+admin_login = "admin"
+admin_password = "$(openssl rand -base64 8)"
+
+; Access settings
+allow_admin_panel = On
+allow_two_factor_auth = Off
+force_two_factor_auth = Off
+admin_panel_host = ""
+admin_panel_key = "admin"
+content_security_policy = ""
+core_install_access_domain = ""
+
+[ssl]
+; Require verification of SSL certificate used.
+verify_certificate = Off
+
+; Allow self-signed certificates. Requires verify_certificate.
+allow_self_signed = On
+
+; Location of Certificate Authority file on local filesystem (/etc/ssl/certs/ca-certificates.crt)
+cafile = ""
+
+; capath must be a correctly hashed certificate directory. (/etc/ssl/certs/)
+capath = ""
+
+[capa]
+folders = On
+composer = On
+contacts = On
+settings = On
+quota = On
+help = On
+reload = On
+search = On
+search_adv = On
+filters = On
+x-templates = Off
+dangerous_actions = On
+message_actions = On
+messagelist_actions = On
+attachments_actions = On
+
+[login]
+default_domain = "$PRIMARY_HOSTNAME"
+
+; Allow language selection on webmail login screen
+allow_languages_on_login = On
+determine_user_language = On
+determine_user_domain = Off
+welcome_page = Off
+forgot_password_link_url = ""
+registration_link_url = ""
+
+; This option allows webmail to remember the logged in user
+; once they closed the browser window.
+; 
+; Values:
+;   "DefaultOff" - can be used, disabled by default;
+;   "DefaultOn"  - can be used, enabled by default;
+;   "Unused"     - cannot be used
+sign_me_auto = "DefaultOff"
+
+[plugins]
+; Enable plugin support
+enable = Off
+
+; List of enabled plugins
+enabled_list = ""
+
+[defaults]
+; Editor mode used by default (Plain, Html, HtmlForced or PlainForced)
+view_editor_type = "Html"
+
+; layout: 0 - no preview, 1 - side preview, 2 - bottom preview
+view_layout = 1
+view_use_checkboxes = On
+autologout = 30
+show_images = Off
+contacts_autosave = On
+mail_use_threads = Off
+mail_reply_same_folder = Off
+
+[logs]
+; Enable logging
+enable = Off
+
+; Logs entire request only if error occured (php requred)
+write_on_error_only = Off
+
+; Logs entire request only if php error occured
+write_on_php_error_only = Off
+
+; Logs entire request only if request timeout (in seconds) occured.
+write_on_timeout_only = 0
+
+; Required for development purposes only.
+; Disabling this option is not recommended.
+hide_passwords = On
+time_offset = 0
+session_filter = ""
+
+; Log filename.
+; For security reasons, some characters are removed from filename.
+; Allows for pattern-based folder creation (see examples below).
+; 
+; Patterns:
+;   {date:Y-m-d}  - Replaced by pattern-based date
+;                   Detailed info: http://www.php.net/manual/en/function.date.php
+;   {user:email}  - Replaced by user's email address
+;                   If user is not logged in, value is set to "unknown"
+;   {user:login}  - Replaced by user's login (the user part of an email)
+;                   If user is not logged in, value is set to "unknown"
+;   {user:domain} - Replaced by user's domain name (the domain part of an email)
+;                   If user is not logged in, value is set to "unknown"
+;   {user:uid}    - Replaced by user's UID regardless of account currently used
+; 
+;   {user:ip}
+;   {request:ip}  - Replaced by user's IP address
+; 
+; Others:
+;   {imap:login} {imap:host} {imap:port}
+;   {smtp:login} {smtp:host} {smtp:port}
+; 
+; Examples:
+;   filename = "log-{date:Y-m-d}.txt"
+;   filename = "{date:Y-m-d}/{user:domain}/{user:email}_{user:uid}.log"
+;   filename = "{user:email}-{date:Y-m-d}.txt"
+filename = "log-{date:Y-m-d}.txt"
+
+; Enable auth logging in a separate file (for fail2ban)
+auth_logging = Off
+auth_logging_filename = "fail2ban/auth-{date:Y-m-d}.txt"
+auth_logging_format = "[{date:Y-m-d H:i:s}] Auth failed: ip={request:ip} user={imap:login} host={imap:host} port={imap:port}"
+
+[debug]
+; Special option required for development purposes
+enable = Off
+
+[social]
+; Google
+google_enable = Off
+google_enable_auth = Off
+google_enable_auth_fast = Off
+google_enable_drive = Off
+google_enable_preview = Off
+google_client_id = ""
+google_client_secret = ""
+google_api_key = ""
+
+; Facebook
+fb_enable = Off
+fb_app_id = ""
+fb_app_secret = ""
+
+; Twitter
+twitter_enable = Off
+twitter_consumer_key = ""
+twitter_consumer_secret = ""
+
+; Dropbox
+dropbox_enable = Off
+dropbox_api_key = ""
+
+[cache]
+; The section controls caching of the entire application.
+; 
+; Enables caching in the system
+enable = On
+
+; Additional caching key. If changed, cache is purged
+index = "v1"
+
+; Can be: files, APC, memcache, redis (beta)
+fast_cache_driver = "files"
+
+; Additional caching key. If changed, fast cache is purged
+fast_cache_index = "v1"
+
+; Browser-level cache. If enabled, caching is maintainted without using files
+http = On
+
+; Caching message UIDs when searching and sorting (threading)
+server_uids = On
+
+[labs]
+; Experimental settings. Handle with care.
+; 
+allow_mobile_version = On
+ignore_folders_subscription = Off
+check_new_password_strength = On
+update_channel = "stable"
+allow_gravatar = On
+allow_prefetch = On
+allow_smart_html_links = On
+cache_system_data = On
+date_from_headers = Off
+autocreate_system_folders = On
+allow_message_append = Off
+disable_iconv_if_mbstring_supported = Off
+login_fault_delay = 1
+log_ajax_response_write_limit = 300
+allow_html_editor_source_button = Off
+allow_html_editor_biti_buttons = Off
+allow_ctrl_enter_on_compose = Off
+try_to_detect_hidden_images = Off
+hide_dangerous_actions = Off
+use_app_debug_js = Off
+use_app_debug_css = Off
+use_imap_sort = On
+use_imap_force_selection = Off
+use_imap_list_subscribe = On
+use_imap_thread = On
+use_imap_move = Off
+use_imap_expunge_all_on_delete = Off
+imap_forwarded_flag = "$Forwarded"
+imap_read_receipt_flag = "$ReadReceipt"
+imap_body_text_limit = 555000
+imap_message_list_fast_simple_search = On
+imap_message_list_count_limit_trigger = 0
+imap_message_list_date_filter = 0
+imap_message_list_permanent_filter = ""
+imap_message_all_headers = Off
+imap_large_thread_limit = 50
+imap_folder_list_limit = 200
+imap_show_login_alert = On
+imap_use_auth_plain = On
+imap_use_auth_cram_md5 = On
+smtp_show_server_errors = Off
+smtp_use_auth_plain = On
+smtp_use_auth_cram_md5 = On
+sieve_allow_raw_script = Off
+sieve_utf8_folder_name = On
+imap_timeout = 300
+smtp_timeout = 60
+sieve_timeout = 10
+domain_list_limit = 99
+mail_func_clear_headers = On
+mail_func_additional_parameters = Off
+favicon_status = On
+folders_spec_limit = 50
+owncloud_save_folder = "Attachments"
+curl_proxy = ""
+curl_proxy_auth = ""
+in_iframe = Off
+force_https = Off
+custom_login_link = ""
+custom_logout_link = ""
+allow_external_login = Off
+allow_external_sso = Off
+external_sso_key = ""
+http_client_ip_check_proxy = Off
+fast_cache_memcache_host = "127.0.0.1"
+fast_cache_memcache_port = 11211
+fast_cache_redis_host = "127.0.0.1"
+fast_cache_redis_port = 6379
+use_local_proxy_for_external_images = Off
+detect_image_exif_orientation = On
+cookie_default_path = ""
+cookie_default_secure = Off
+replace_env_in_configuration = ""
+startup_url = ""
+emogrifier = On
+dev_email = ""
+dev_password = ""
+
+[version]
+current = "1.10.1.127"
+saved = "Fri, 01 Jul 2016 03:41:58 +0000"
 EOF
 
-# Configure vaction_sieve.
+# Add localhost imap/smtp
-cat > /usr/local/lib/roundcubemail/plugins/vacation_sieve/config.inc.php <<EOF;
+
-<?php
+cat > /usr/local/lib/rainloop/data/_data_/_default_/domains/default.ini <<EOF;
-/* Do not edit. Written by Mail-in-a-Box. Regenerated on updates. */
+imap_host = "127.0.0.1"
-\$rcmail_config['vacation_sieve'] = array(
+imap_port = 993
-    'date_format' => 'd/m/Y',
+imap_secure = "SSL"
-    'working_hours' => array(8,18),
+imap_short_login = Off
-    'msg_format' => 'text',
+sieve_use = On
-    'logon_transform' => array('#([a-z])[a-z]+(\.|\s)([a-z])#i', '\$1\$3'),
+sieve_allow_raw = Off
-    'transfer' => array(
+sieve_host = "127.0.0.1"
-        'mode' =>  'managesieve',
+sieve_port = 4190
-        'ms_activate_script' => true,
+sieve_secure = "None"
-        'host'   => '127.0.0.1',
+smtp_host = "127.0.0.1"
-        'port'   => '4190',
+smtp_port = 587
-        'usetls' => false,
+smtp_secure = "TLS"
-        'path' => 'vacation',
+smtp_short_login = Off
-    )
+smtp_auth = On
-);
+smtp_php_mail = Off
 EOF
 
-# Create writable directories.
+# Fix permissions after editing configs
-mkdir -p /var/log/roundcubemail /tmp/roundcubemail $STORAGE_ROOT/mail/roundcube
-chown -R www-data.www-data /var/log/roundcubemail /tmp/roundcubemail $STORAGE_ROOT/mail/roundcube
 
-# Password changing plugin settings
+find /usr/local/lib/rainloop -type d -exec chmod 755 {} \;
-# The config comes empty by default, so we need the settings 
+find /usr/local/lib/rainloop -type f -exec chmod 644 {} \;
-# we're not planning to change in config.inc.dist...
+chown -R www-data:www-data /usr/local/lib/rainloop
-cp /usr/local/lib/roundcubemail/plugins/password/config.inc.php.dist \
-	/usr/local/lib/roundcubemail/plugins/password/config.inc.php
-
-tools/editconf.py /usr/local/lib/roundcubemail/plugins/password/config.inc.php \
-	"\$config['password_minimum_length']=6;" \
-	"\$config['password_db_dsn']='sqlite:///$STORAGE_ROOT/mail/users.sqlite';" \
-	"\$config['password_query']='UPDATE users SET password=%D WHERE email=%u';" \
-	"\$config['password_dovecotpw']='/usr/bin/doveadm pw';" \
-	"\$config['password_dovecotpw_method']='SHA512-CRYPT';" \
-	"\$config['password_dovecotpw_with_method']=true;"
-
-# so PHP can use doveadm, for the password changing plugin
-usermod -a -G dovecot www-data
-
-# set permissions so that PHP can use users.sqlite
-# could use dovecot instead of www-data, but not sure it matters
-chown root.www-data $STORAGE_ROOT/mail
-chmod 775 $STORAGE_ROOT/mail
-chown root.www-data $STORAGE_ROOT/mail/users.sqlite 
-chmod 664 $STORAGE_ROOT/mail/users.sqlite 
-
-# Run Roundcube database migration script, if the database exists (it's created by
-# Roundcube on first use).
-if [ -f $STORAGE_ROOT/mail/roundcube/roundcube.sqlite ]; then
-	/usr/local/lib/roundcubemail/bin/updatedb.sh --dir /usr/local/lib/roundcubemail/SQL --package roundcube
-fi
 
 # Enable PHP modules.
 php5enmod mcrypt
 restart_service php5-fpm
+
+# remove Roundcube
+# rm -rf /usr/local/lib/roundcube