From 4ea091174ce896e1293689de76f7a5122c4e834e Mon Sep 17 00:00:00 2001
From: Luke Shumaker
Date: Wed, 23 Nov 2016 00:12:05 -0500
Subject: Make the instance name and domain configurable.
---
aurweb/git/serve.py | 4 +++-
aurweb/scripts/mkpkglists.py | 6 +++---
aurweb/scripts/notify.py | 40 +++++++++++++++++++-----------------
conf/config.proto | 3 +++
web/html/home.php | 28 +++++++++++++++----------
web/html/login.php | 4 ++--
web/html/pkgdel.php | 4 ++--
web/html/rss.php | 8 ++++----
web/lib/DB.class.php | 2 +-
web/template/account_delete.php | 3 ++-
web/template/account_edit_form.php | 2 +-
web/template/footer.php | 2 +-
web/template/header.php | 8 ++++----
web/template/stats/updates_table.php | 2 +-
14 files changed, 65 insertions(+), 51 deletions(-)
diff --git a/aurweb/git/serve.py b/aurweb/git/serve.py
index 476aea8..3949dbf 100755
--- a/aurweb/git/serve.py
+++ b/aurweb/git/serve.py
@@ -10,6 +10,8 @@ import time
import aurweb.config
import aurweb.db
+aur_shortname = aurweb.config.get('options', 'aur_shortname');
+
notify_cmd = aurweb.config.get('notifications', 'notify-cmd')
repo_path = aurweb.config.get('serve', 'repo-path')
@@ -345,7 +347,7 @@ def main():
if enable_maintenance:
if remote_addr not in maintenance_exc:
- die("The AUR is down due to maintenance. We will be back soon.")
+ die("The %s is down due to maintenance. We will be back soon." % (aur_shortname))
if action == 'git' and cmdargv[1] in ('upload-pack', 'receive-pack'):
action = action + '-' + cmdargv[1]
diff --git a/aurweb/scripts/mkpkglists.py b/aurweb/scripts/mkpkglists.py
index 8a0f2e9..7d0b5c5 100755
--- a/aurweb/scripts/mkpkglists.py
+++ b/aurweb/scripts/mkpkglists.py
@@ -8,14 +8,14 @@ import aurweb.db
packagesfile = aurweb.config.get('mkpkglists', 'packagesfile')
pkgbasefile = aurweb.config.get('mkpkglists', 'pkgbasefile')
-
+aur_shortname = aurweb.config.get('options', 'aur_shortname');
def main():
conn = aurweb.db.Connection()
datestr = datetime.datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S GMT")
- pkglist_header = "# AUR package list, generated on " + datestr
- pkgbaselist_header = "# AUR package base list, generated on " + datestr
+ pkglist_header = "# " + aur_shortname + " package list, generated on " + datestr
+ pkgbaselist_header = "# " + aur_shortname + " package base list, generated on " + datestr
with gzip.open(packagesfile, "w") as f:
f.write(bytes(pkglist_header + "\n", "UTF-8"))
diff --git a/aurweb/scripts/notify.py b/aurweb/scripts/notify.py
index ddd6e49..e9458b4 100755
--- a/aurweb/scripts/notify.py
+++ b/aurweb/scripts/notify.py
@@ -10,11 +10,13 @@ import aurweb.db
aur_location = aurweb.config.get('options', 'aur_location')
aur_request_ml = aurweb.config.get('options', 'aur_request_ml')
+aur_shortname = aurweb.config.get('options', 'aur_shortname');
+aur_longname = aurweb.config.get('options', 'aur_longname');
sendmail = aurweb.config.get('notifications', 'sendmail')
sender = aurweb.config.get('notifications', 'sender')
reply_to = aurweb.config.get('notifications', 'reply-to')
-
+domain = aurweb.config.get('notifications', 'domain');
def headers_cc(cclist):
return {'Cc': str.join(', ', cclist)}
@@ -174,7 +176,7 @@ def send_resetkey(conn, uid):
'WHERE ID = ?', [uid])
username, to, resetkey = cur.fetchone()
- subject = 'AUR Password Reset'
+ subject = '%s Password Reset' % (aur_shortname)
body = 'A password reset request was submitted for the account %s ' \
'associated with your email address. If you wish to reset your ' \
'password follow the link [1] below, otherwise ignore this ' \
@@ -189,11 +191,11 @@ def welcome(conn, uid):
'WHERE ID = ?', [uid])
username, to, resetkey = cur.fetchone()
- subject = 'Welcome to the Arch User Repository'
- body = 'Welcome to the Arch User Repository! In order to set an initial ' \
+ subject = 'Welcome to the %s' % (aur_longname)
+ body = 'Welcome to the %s! In order to set an initial ' \
'password for your new account, please click the link [1] below. ' \
'If the link does not work, try copying and pasting it into your ' \
- 'browser.'
+ 'browser.' % (aur_longname)
refs = '[1] ' + aur_location + '/passreset/?resetkey=' + resetkey
send_notification([to], subject, body, refs)
@@ -208,7 +210,7 @@ def comment(conn, uid, pkgbase_id, comment_id):
user_uri = aur_location + '/account/' + user + '/'
pkgbase_uri = aur_location + '/pkgbase/' + pkgbase + '/'
- subject = 'AUR Comment for %s' % (pkgbase)
+ subject = '%s Comment for %s' % (aur_shortname, pkgbase)
body = '%s [1] added the following comment to %s [2]:' % (user, pkgbase)
body += '\n\n' + text + '\n\n'
body += 'If you no longer wish to receive notifications about this ' \
@@ -216,7 +218,7 @@ def comment(conn, uid, pkgbase_id, comment_id):
('Disable notifications')
refs = '[1] ' + user_uri + '\n'
refs += '[2] ' + pkgbase_uri
- thread_id = ''
+ thread_id = ''
headers = headers_reply(thread_id)
send_notification(to, subject, body, refs, headers)
@@ -230,7 +232,7 @@ def update(conn, uid, pkgbase_id):
user_uri = aur_location + '/account/' + user + '/'
pkgbase_uri = aur_location + '/pkgbase/' + pkgbase + '/'
- subject = 'AUR Package Update: %s' % (pkgbase)
+ subject = '%s Package Update: %s' % (aur_shortname, pkgbase)
body = '%s [1] pushed a new commit to %s [2].' % (user, pkgbase)
body += '\n\n'
body += 'If you no longer wish to receive notifications about this ' \
@@ -238,7 +240,7 @@ def update(conn, uid, pkgbase_id):
('Disable notifications')
refs = '[1] ' + user_uri + '\n'
refs += '[2] ' + pkgbase_uri
- thread_id = ''
+ thread_id = ''
headers = headers_reply(thread_id)
send_notification(to, subject, body, refs, headers)
@@ -253,7 +255,7 @@ def flag(conn, uid, pkgbase_id):
user_uri = aur_location + '/account/' + user + '/'
pkgbase_uri = aur_location + '/pkgbase/' + pkgbase + '/'
- subject = 'AUR Out-of-date Notification for %s' % (pkgbase)
+ subject = '%s Out-of-date Notification for %s' % (aur_shortname, pkgbase)
body = 'Your package %s [1] has been flagged out-of-date by %s [2]:' % \
(pkgbase, user)
body += '\n\n' + text
@@ -271,7 +273,7 @@ def adopt(conn, pkgbase_id, uid):
user_uri = aur_location + '/account/' + user + '/'
pkgbase_uri = aur_location + '/pkgbase/' + pkgbase + '/'
- subject = 'AUR Ownership Notification for %s' % (pkgbase)
+ subject = '%s Ownership Notification for %s' % (aur_shortname, pkgbase)
body = 'The package %s [1] was adopted by %s [2].' % (pkgbase, user)
refs = '[1] ' + pkgbase_uri + '\n'
refs += '[2] ' + user_uri
@@ -287,7 +289,7 @@ def disown(conn, pkgbase_id, uid):
user_uri = aur_location + '/account/' + user + '/'
pkgbase_uri = aur_location + '/pkgbase/' + pkgbase + '/'
- subject = 'AUR Ownership Notification for %s' % (pkgbase)
+ subject = '%s Ownership Notification for %s' % (aur_shortname, pkgbase)
body = 'The package %s [1] was disowned by %s [2].' % (pkgbase, user)
refs = '[1] ' + pkgbase_uri + '\n'
refs += '[2] ' + user_uri
@@ -301,7 +303,7 @@ def comaintainer_add(conn, pkgbase_id, uid):
pkgbase_uri = aur_location + '/pkgbase/' + pkgbase + '/'
- subject = 'AUR Co-Maintainer Notification for %s' % (pkgbase)
+ subject = '%s Co-Maintainer Notification for %s' % (aur_shortname, pkgbase)
body = 'You were added to the co-maintainer list of %s [1].' % (pkgbase)
refs = '[1] ' + pkgbase_uri + '\n'
@@ -314,7 +316,7 @@ def comaintainer_remove(conn, pkgbase_id, uid):
pkgbase_uri = aur_location + '/pkgbase/' + pkgbase + '/'
- subject = 'AUR Co-Maintainer Notification for %s' % (pkgbase)
+ subject = '%s Co-Maintainer Notification for %s' % (aur_shortname, pkgbase)
body = ('You were removed from the co-maintainer list of %s [1].' %
(pkgbase))
refs = '[1] ' + pkgbase_uri + '\n'
@@ -332,7 +334,7 @@ def delete(conn, uid, old_pkgbase_id, new_pkgbase_id=None):
user_uri = aur_location + '/account/' + user + '/'
pkgbase_uri = aur_location + '/pkgbase/' + old_pkgbase + '/'
- subject = 'AUR Package deleted: %s' % (old_pkgbase)
+ subject = '%s Package deleted: %s' % (aur_shortname, old_pkgbase)
if new_pkgbase_id:
new_pkgbase_uri = aur_location + '/pkgbase/' + new_pkgbase + '/'
body = '%s [1] merged %s [2] into %s [3].\n\n' \
@@ -378,7 +380,7 @@ def request_open(conn, uid, reqid, reqtype, pkgbase_id, merge_into=None):
body += '\n\n' + text
refs = '[1] ' + user_uri + '\n'
refs += '[2] ' + pkgbase_uri + '\n'
- thread_id = ''
+ thread_id = ''
# Use a deterministic Message-ID for the first email referencing a request.
headers = headers_msgid(thread_id)
headers.update(headers_cc(cc))
@@ -398,14 +400,14 @@ def request_close(conn, uid, reqid, reason):
body = 'Request #%d has been %s by %s [1]' % (int(reqid), reason, user)
refs = '[1] ' + user_uri
else:
- body = 'Request #%d has been %s automatically by the Arch User ' \
- 'Repository package request system' % (int(reqid), reason)
+ body = 'Request #%d has been %s automatically by the %s ' \
+ 'package request system' % (int(reqid), reason, aur_longname)
refs = None
if text.strip() == '':
body += '.'
else:
body += ':\n\n' + text
- thread_id = ''
+ thread_id = ''
headers = headers_reply(thread_id)
headers.update(headers_cc(cc))
diff --git a/conf/config.proto b/conf/config.proto
index 96fad80..60d6211 100644
--- a/conf/config.proto
+++ b/conf/config.proto
@@ -31,12 +31,15 @@ log_uri = https://aur.archlinux.org/cgit/aur.git/log/?h=%s
snapshot_uri = /cgit/aur.git/snapshot/%s.tar.gz
enable-maintenance = 1
maintenance-exceptions = 127.0.0.1
+aur_shortname = AUR
+aur_longname = Arch User Repository
[notifications]
notify-cmd = /srv/http/aurweb/scripts/notify.py
sendmail = /usr/bin/sendmail
sender = notify@aur.archlinux.org
reply-to = noreply@aur.archlinux.org
+domain = aur.archlinux.org
[fingerprints]
Ed25519 = SHA256:HQ03dn6EasJHNDlt51KpQpFkT3yBX83x7BoIkA1iv2k
diff --git a/web/html/home.php b/web/html/home.php
index 475370b..d4bbc0e 100644
--- a/web/html/home.php
+++ b/web/html/home.php
@@ -15,14 +15,17 @@ html_header( __("Home") );
-
AUR = __("Home"); ?>
+
= config_get('options', 'aur_shortname'); ?> = __("Home"); ?>
',
+ config_get('options', 'aur_shortname'),
'',
'',
+ config_get('options', 'aur_shortname'),
' '
);
?>
@@ -58,7 +61,7 @@ html_header( __("Home") );
= __('Orphan Request') ?> : = __('Request a package to be disowned, e.g. when the maintainer is inactive and the package has been flagged out-of-date for a long time.') ?>
- = __('Deletion Request') ?> : = __('Request a package to be removed from the Arch User Repository. Please do not use this if a package is broken and can be fixed easily. Instead, contact the package maintainer and file orphan request if necessary.') ?>
+ = __('Deletion Request') ?> : = __('Request a package to be removed from the %s. Please do not use this if a package is broken and can be fixed easily. Instead, contact the package maintainer and file orphan request if necessary.', config_get('options', 'aur_longname')) ?>
= __('Merge Request') ?> : = __('Request a package to be merged into another one. Can be used when a package needs to be renamed or replaced by a split package.') ?>
@@ -76,7 +79,8 @@ html_header( __("Home") );
',
''
);
@@ -84,7 +88,7 @@ html_header( __("Home") );
- = __('The following SSH fingerprints are used for the AUR:') ?>
+ = __('The following SSH fingerprints are used for the %s:', config_get('options', 'aur_shortname')) ?>
$fingerprint): ?>
@@ -98,11 +102,12 @@ html_header( __("Home") );
',
- '',
- '',
- ' '
+ 'General discussion regarding the %s (%s) and Trusted User structure takes place on %s. For discussion relating to the development of the %s web interface (aurweb), use the %s mailing list.',
+ config_get('options', 'aur_longname'),
+ config_get('options', 'aur_shortname'),
+ 'aur-general ',
+ config_get('options', 'aur_shortname'),
+ 'aur-dev '
);
?>
@@ -112,7 +117,8 @@ html_header( __("Home") );
',
'',
'',
diff --git a/web/html/login.php b/web/html/login.php
index 7345439..6617489 100644
--- a/web/html/login.php
+++ b/web/html/login.php
@@ -11,10 +11,10 @@ if (!$disable_http_login || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'])) {
$login_error = $login['error'];
}
-html_header('AUR ' . __("Login"));
+html_header(config_get('options', 'aur_shortname') . ' ' . __("Login"));
?>
-
AUR = __('Login') ?>
+
= config_get('options', 'aur_shortname'); ?> = __('Login') ?>
= __("Logged-in as: %s", '' . username_from_sid($_COOKIE["AURSID"]) . ' '); ?>
diff --git a/web/html/pkgdel.php b/web/html/pkgdel.php
index 21a2677..a52f568 100644
--- a/web/html/pkgdel.php
+++ b/web/html/pkgdel.php
@@ -14,8 +14,8 @@ if (has_credential(CRED_PKGBASE_DELETE)): ?>
= __('Delete Package') ?>: htmlspecialchars($pkgbase_name) ?>
- = __('Use this form to delete the package base %s%s%s and the following packages from the AUR: ',
- '', htmlspecialchars($pkgbase_name), ' '); ?>
+ = __('Use this form to delete the package base %s%s%s and the following packages from the %s: ',
+ '', htmlspecialchars($pkgbase_name), ' ', config_get('options', 'aur_shortname')); ?>
diff --git a/web/html/rss.php b/web/html/rss.php
index 8585d81..85df447 100644
--- a/web/html/rss.php
+++ b/web/html/rss.php
@@ -26,15 +26,15 @@ $rss->xslStyleSheet = false;
$rss->encoding = "UTF-8";
#All the general RSS setup
-$rss->title = "AUR Newest Packages";
-$rss->description = "The latest and greatest packages in the AUR";
+$rss->title = config_get('options', 'aur_shortname') . " Newest Packages";
+$rss->description = "The latest and greatest packages in the " . config_get('options', 'aur_shortname');
$rss->link = "${protocol}://{$host}";
$rss->syndicationURL = "{$protocol}://{$host}" . get_uri('/rss/');
$image = new FeedImage();
-$image->title = "AUR";
+$image->title = config_get('options', 'aur_shortname');
$image->url = "{$protocol}://{$host}/css/archnavbar/aurlogo.png";
$image->link = $rss->link;
-$image->description = "AUR Newest Packages Feed";
+$image->description = config_get('options', 'aur_shortname') . " Newest Packages Feed";
$rss->image = $image;
#Get the latest packages and add items for them
diff --git a/web/lib/DB.class.php b/web/lib/DB.class.php
index b538e0d..ce62ec6 100644
--- a/web/lib/DB.class.php
+++ b/web/lib/DB.class.php
@@ -32,7 +32,7 @@ class DB {
self::$dbh = new PDO($dsn, $user, $password);
self::$dbh->exec("SET NAMES 'utf8' COLLATE 'utf8_general_ci';");
} catch (PDOException $e) {
- die('Error - Could not connect to AUR database');
+ die('Error - Could not connect to ' . config_get('options', 'aur_shortname') . ' database');
}
}
diff --git a/web/template/account_delete.php b/web/template/account_delete.php
index 74f386d..ca6c6ce 100644
--- a/web/template/account_delete.php
+++ b/web/template/account_delete.php
@@ -1,5 +1,6 @@
- = __('You can use this form to permanently delete the AUR account %s.', '' . htmlspecialchars($username) . ' ') ?>
+ = __('You can use this form to permanently delete the %s account %s.',
+ config_get('options', 'aur_shortname'), '' . htmlspecialchars($username) . ' ') ?>
= __('%sWARNING%s: This action cannot be undone.', '', ' ') ?>
diff --git a/web/template/account_edit_form.php b/web/template/account_edit_form.php
index 19821a0..2572157 100644
--- a/web/template/account_edit_form.php
+++ b/web/template/account_edit_form.php
@@ -132,7 +132,7 @@
- = __("The following information is only required if you want to submit packages to the Arch User Repository.") ?>
+ = __("The following information is only required if you want to submit packages to the %s.", config_get('options', 'aur_longname')) ?>
= __("SSH Public Key") ?>:
diff --git a/web/template/footer.php b/web/template/footer.php
index 572dbb2..0431792 100644
--- a/web/template/footer.php
+++ b/web/template/footer.php
@@ -6,7 +6,7 @@
aurweb = htmlspecialchars($ver) ?>
= __('Copyright %s 2004-%d aurweb Development Team.', '©', date('Y')) ?>
- = __('AUR packages are user produced content. Any use of the provided files is at your own risk.') ?>
+ = __('%s packages are user produced content. Any use of the provided files is at your own risk.', config_get('options', 'aur_shortname')) ?>
diff --git a/web/template/header.php b/web/template/header.php
index 874109a..96bf6c5 100644
--- a/web/template/header.php
+++ b/web/template/header.php
@@ -4,7 +4,7 @@