Difference between revisions of "User:TerryE/phpBB3.0.7 Upgrade/Issues and Actions"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Forum Customisation)
(Logfile Retention Policy: Move to closed)
 
(42 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
I have included the list of open issues and activities that I intend to carried out as part of the phpBB V3.0.7 upgrade below.   
 
I have included the list of open issues and activities that I intend to carried out as part of the phpBB V3.0.7 upgrade below.   
 
== The Core Build ==
 
== The Core Build ==
=== Code Base ===
 
  
* The core phpBB code base from [http://www.ohloh.net/p/phpbb/download?filename=phpBB-3.0.7.tar.bz2 phpBB 3.0.7 Download]
+
This work is now complete and all ten live NL databases migrated to 3.0.7. See [[User:TerryE/phpBB3.0.7 Upgrade/Closed Issues and Actions#The Core Build|Closed Issues and Actions]] for details on the process.
* The following language packs from [http://www.phpbb.com/languages/ phpBB 3.0.x Languages] repository. These are maintained in the site '''/files/language_packs_30x/''' sub-directory
+
  
{| class="prettytable"
+
== Round-off and archive ==
| <center>'''Language '''</center>
+
| <center>'''Language files '''</center>
+
| <center>'''Prosilver GIFs '''</center>
+
  
|-
+
See [[User:TerryE/phpBB3.0.7 Upgrade/Closed Issues and Actions#The Core Build|Closed Issues and Actions]] for details on the following completed activities:
| English (U.K.) || (built-in) || (built-in)
+
|-
+
| English (U.S.) || lang_en_us.tar.gz || prosilver_en_us.tar.gz
+
|-
+
| French || lang_fr.tar.gz || prosilver_fr.tar.gz
+
|-
+
| Catalan || lang_ca.tar.gz || prosilver_ca.tar.gz
+
|-
+
| Catalan (Valencian) || lang_ca_pv.tar.gz || prosilver_ca_pv.tar.gz
+
|-
+
| Dutch || lang_nl.tar.gz || prosilver_nl.tar.gz
+
|-
+
| Hungarian || lang_hu.tar.gz || prosilver_hu.tar.gz
+
|-
+
| Italian || lang_it.tar.gz || prosilver_it.tar.gz
+
|-
+
| Japanese || lang_ja.tar.gz || prosilver_ja.tar.gz
+
|-
+
| Mandarin Chinese (Traditional script) || lang_zh_cmn_hant.tar.gz || prosilver_zh_cmn_hant.tar.gz
+
|-
+
| Mandarin Chinese (Simplified script) || lang_zh_cmn_hans.tar.gz || prosilver_zh_cmn_hans.tar.gz
+
|-
+
| Polish || lang_pl.tar.gz || prosilver_pl.tar.gz
+
|-
+
| Spanish || lang_es.tar.gz || prosilver_es.tar.gz
+
|-
+
| Spanish (Argentina) || lang_es_ar.tar.gz || prosilver_es_ar.tar.gz
+
|-
+
| Vietnamese || lang_vi.tar.gz || prosilver_vi.tar.gz
+
|}
+
I've pulled these down to a <tt>kits</tt> directory from the '''phpBB''' server.
+
for co in ca ca_pv en_us es es_ar fr hu it ja nl pl vi zh_cmn_hant zh_cmn_hans; do
+
  wget <nowiki>http://www.phpbb.com/files/language_packs_30x/lang_$co.tar.gz</nowiki>
+
  wget <nowiki>http://www.phpbb.com/files/language_packs_30x/prosilver_$co.tar.gz</nowiki>
+
done
+
On top of this I also have two tarballs and one custom module for my OOo specific additions:
+
* '''OOoImages.tar.bz2''' which includes the extra avatar libraries, smileys etc. used on the forums.
+
* '''OOoImages.tar.bz2''' which includes the forum logos for each of the NL forums and Oracle GIFs.
+
* '''acm_mysqli.php''' a module which uses MySQL to implement the phpBB [http://wiki.phpbb.com/Cache cache].
+
  
=== Forum Customisation ===
+
* Automated administrator email responder
The following customisations have been carried over from Version 3.0.5, and the patch file which applies these changes has been regressed from the 3.0.5 code base to the 3.0.7 code base:
+
* Automated unactivated users prune
 +
* Automated backup
 +
* Forum watchdog
 +
* Oracle branding
 +
* Retiring custom fields
  
# '''Reorder window title to make multi-tab title more usable'''. All browser tabs are labelled with their title. The phpBB3 default is to begin the title with the forum name then page category, hence if you have a lot of tabs open they are called openOffi... By putting the specific title first, it makes it a lot easier to pick the correct tab.
+
I need still need to clean out any temporary archive files, and archive the core set of sh and patch files so that I can pick this up as a basis of a future 3.0.7 -> 3.x upgrade.
#:<tt>viewforum.php</tt>, <tt>viewtopic.php</tt>
+
# '''Add Expand option to Code Block'''. phpBB3 now puts each code block in a scrollable window. This makes it a pain if you want to see all of the code in the browser. This mod adds an Expand option to the code block to allow you to blow it up to full size.
+
#:<tt>template/bbcode.html</tt>, <tt>template/forum_fn.js</tt>, <tt>theme/content.css</tt>, <tt>theme/bidi.css</tt>
+
# '''Tweak Access key codes to remove conflicts'''. For those that use keyboard accelerators within the browser, the lack of a shortcut for Preview Post is a pain. This makes '''<nowiki><Accel>+P</nowiki>''' a shortcut for Preview and '''<nowiki><Accel>+G</nowiki>''' a shortcut for graphics.
+
#:<tt>template/posting_buttons.html</tt>, <tt>template/index_body.html</tt>, <tt>template/posting_editor.html</tt>
+
# '''Add Active Post count to View Active Topics'''. This just adds a count of new posts in the Active topics heading.
+
#:<tt>index.php</tt>
+
# '''Add truncated title of last topic to Forum View'''. Lots of OOo volunteers asked for this one. It enables you to recognise at a glance if a forum has any new posts in it.
+
#:<tt>includes/functions_display.php</tt>, <tt>template/forumlist_body.html</tt>
+
# '''Customise Headers and Footers to OpenOffice.org branding'''. Add OOo Community logo and adjust framing colours to match. Add OOo favicon.
+
#:<tt>includes/functions.php</tt>, <tt>template/overall_footer.html</tt>, <tt>template/overall_header.html</tt>, <tt>theme/colours.css</tt>, <tt>theme/bidi.css</tt>, <tt>theme/common.css</tt>, <tt>XX/common.php</tt>
+
# '''Add OpenOffice.org Qs to BB FAQ'''. The FAQ button goes to a phpBB3 standard FAQ which is all about using phpBB3. I've added a Q0 which points the user to the wiki and forum FAQs for openOffice.org info.
+
#:<tt>en/help_faq.php</tt>
+
# '''Add instruction to “read Survival Guide before posting” to post form'''. The posting form now includes an instruction to read the survival guide before you post. (This is only shown if you have less than 15 posts).
+
#:<tt>posting.php</tt>, <tt>template/posting_layout.html</tt>, <tt>XX/common.php</tt>
+
# '''Optional Mandatory Subject on Registration'''. This is a customisation which was introduced in the French forum, and we have now rolled this out across all forums.
+
#:<tt>includes/functions_user.php</tt>, <tt>includes/ucp/ucp_register.php</tt>, <tt>template/ucp_register.html</tt>, <tt>XX/common.php</tt>
+
# '''Change move topic default'''.  This no longer leaves a shadow topic by default.
+
#:<tt>template/mcp_move.html</tt>
+
# '''Add Poster's warning count for moderators'''.  This was a specific request from the FR moderators.  If a poster has outstanding warnings then moderators will see his/her warning count in the post heading column.
+
#:<tt>template/viewtopic_body.html</tt>
+
# '''Allow Cron to be run as batch script'''.  This allows cron jobs to be scheduled using a cron script.
+
#:<tt>cron.php</tt>
+
# '''Runtime optimisations'''.  This is replace the file based caching with SQL caching.
+
#:<tt>includes/acm/acm_memory.php</tt>
+
# '''Miscellaneous OOo configuration'''.  The batch equivalent of the interactive phpBB setup.
+
#:<tt>config.php</tt>, <tt>install/database_update.php</tt>, <tt>fr/mcp.php</tt>, <tt>fr/acp/common.php</tt>
+
# '''Customisations that are configurable through phpBB'''. These don't need code or style changes:
+
#* Add custom fields to define users, main OS, installed OOo version and supplementary OSs.
+
#* <nowiki>Add additional BBcodes for [edit], [pre], [strike], [center], </nowiki><nowiki>[sub], [super], [hr]</nowiki>
+
  
Note that the ''<tt>XX/</tt>''above refers to all 15 language variants <tt>ca</tt>, etc.
+
== Enabling Atom Feeds ==
 +
A number of the power users on the '''FR''' forum used the previous RSS feed.  This functionality has been dropped and an equivalent needs reinstituted.  The previous mod implementation adopted the [http://www.phpbb.com/community/viewtopic.php?f=69&t=1189825 Simple RSS mod for phpBB3].  However, this mod has significant limitations that I can't ignore; most importantly it bypasses the phpBB access control system, allowing unregistered users to browse closed forums.  I didn't get this working properly but this functionality is now superseded by a standard php V306 feature to provide ATOM feeds. 
 +
* We need to investigate its implementation for those forums that want it, as it requires  enabling / configuring through ACP.
 +
* I need to discuss this further with the FR proponents of this mod.
 +
* Note that for some reason, the ATOM feed link isn't being displayed if the Feed is enable.  I need to investigate this.
  
=== The build process ===
+
== Basic Management Reporting ==
  
This is a modified rerun of what I did for the 3.0.4 and 3.0.5 upgrades.  I use a [http://www.VirtualBox.org VirtualBox/] customised LAMP VM appliance based on [http://www.ubuntu.com/products/whatisubuntu/serveredition/jeos Ubuntu JeOS]. OK, this is Linux rather than Solaris, but in terms of the AMP stack elements it is functionally the same, and contains a full copy of the live database.  I build and dress rehearse the 3.0.7 build and 3.0.5 → 3.0.7 upgrade on this.  I then move and blow the complete 307 tarball into the live system and repeat the 3.0.5 → 3.0.7 upgrade live.  (I prefer to do it this say since I prefer the Linux utilities and the gnu extensions to diff, patch, etc.)
+
Some of the NL forums are clearly active and healthy. Some clearly less so.  However, we have no objective measures in place to identify any issues that are arising and any trends that need to trigger additional support for any individual forum that might be having problemsOne option here might be to introduce some basic health measures so that we can maintain a simple forum dashboard.
 
+
The painful bit in all this is regressing the 3.0.5 patch file to the 3.0.7 code base as this is a largely manual activity, but once this has been done I have scripted the various steps to automate the build.  These are pretty simple and self-explanatory so I won't go into details here.  However, I have changed the installation in line with the Debian standard of ''phpBB'':
+
* The ''phpBB'' install is now homed in '''<tt>/var/lib/phpBB</tt>''' with two separate sub-directories for each version, e.g. '''<tt>ref307</tt>''' and '''<tt>com307</tt>'''.  The first of these is an "out of the box" phpBB install with no modifications.  The second is the OOo customised install.  OK, this incurs a 20Mb overhead, but this is a very simple method of tracking any uncontrolled changes in prod as diffing the '''ref''XXX''''' and '''com''XXX''''' will throw these up. 
+
 
+
All templates and code are designed to be mappable into all code bases.  The individual forum instances are in the directories '''<tt>/var/www/''XX''/forum</tt>''' and I have a simple script maps the necessary symlinks from this directory hierarchy to the common production directory, that is '''<tt>/var/lib/phpBB/com307</tt>''' for version 3.0.7.
+
 
+
== Automated Backup ==
+
 
+
I had a set of scripts that ran as a cron job for the old server with the PostgresSQL D/B, but I turned these off when I moved to MySQL and we decommissioned using the OUCV server as a second siteI have a script which I use manually about once per week (on top of standard Solaris backups), but I would prefer to have a nightly incremental dump.
+
 
+
== Automated Unactivated Users Prune ==
+
 
+
This is another batch script that I have still in development.  It automates a tedious twice weekly task. Low priority until the issues which are impacting the NL Administrators are sorted.
+
 
+
== Automated Administrator Email Responder ==
+
 
+
V1 of this was developed about a year ago.  I upgraded V2 to Python for deployment with phpBB V305.  This fails to part about 5% of valid email queries and rejects these as errors.  I need to fix this as part of the upgrade to V307.
+
== Logfile Retention Policy ==
+
 
+
At the moment I've configured Logfile rotation on the Apache access and error logs on a weekly basis.  At the moment I periodically compress old logs and delete access logs older the 3 months.  Rotation on the MySQL logs is also done on an adhoc basis. I need to implement a simple weekly cron task which:
+
* Rotates the Mysql log
+
* Compresses logs older than one week
+
* Deletes the compress access and mysql error logs files older than 3 months.
+
 
+
== Oracle Branding ==
+
 
+
Now that Oracle has acquired Sun, some of the Sun Footer logos have been replaced with Oracle branding ones.  <s>I will sort this out as part of this upgrade.</s>  I've done this earlier by request of Clayton.
+
 
+
== Retiring Custom Fields ==
+
 
+
This functionality has been moved into the standard signature format.  I have already done this for the EN forums and swithed off the use of custom fields in the creation of new accounts on all forums,  but I've got about existing 800 accounts across three NL forums where I need to move this data into the signatures.
+
 
+
== RSS Feed ==
+
 
+
A number of the power users on the '''fr''' forum used the previous RSS feed.  This functionality has been temporarily dropped and needs reinstituted.  The current implementation adopts the [http://www.phpbb.com/community/viewtopic.php?f=69&t=1189825 Simple RSS mod for phpBB3].  However, this mod has significant limitations that I can't ignore.  Most importantly it bypasses the phpBB access control system, allowing unregistered users to browse closed forums.  I didn't get this working properly but this functionality is now superseded by a standard php V306 feature. I need to discuss this further with the fr proponents of this mod.
+
  
 
== Standardising Forum Configurations ==  
 
== Standardising Forum Configurations ==  
  
With 9 forums ''any'' degree of divergence can cause problems on upgrade and through-life maintenance, so we need to standardise where possible.  I am ''not'' talking about language packs or basic forum structure but things like the extra BBcodes, permissible file extensions for upload, etc..  If they make sense in one OOo forum then they should be in all.
+
With 10 forums ''any'' degree of divergence can cause problems on upgrade and through-life maintenance, so we need to standardise where possible.  I am ''not'' talking about language packs or basic forum structure but things like the extra BBcodes, permissible file extensions for upload, etc..  If they make sense in one OOo forum then they should be in all.
  
 
== Write up phpBB 3.0.7 configuration ==
 
== Write up phpBB 3.0.7 configuration ==
  
 
I have decided to do this in the phpBB wiki because this will be of more interest to phpBB admins rather than OOo Volunteers and NL Admins.  I will post the link here when I've done it.
 
I have decided to do this in the phpBB wiki because this will be of more interest to phpBB admins rather than OOo Volunteers and NL Admins.  I will post the link here when I've done it.

Latest revision as of 11:16, 30 August 2011

I have included the list of open issues and activities that I intend to carried out as part of the phpBB V3.0.7 upgrade below.

The Core Build

This work is now complete and all ten live NL databases migrated to 3.0.7. See Closed Issues and Actions for details on the process.

Round-off and archive

See Closed Issues and Actions for details on the following completed activities:

  • Automated administrator email responder
  • Automated unactivated users prune
  • Automated backup
  • Forum watchdog
  • Oracle branding
  • Retiring custom fields

I need still need to clean out any temporary archive files, and archive the core set of sh and patch files so that I can pick this up as a basis of a future 3.0.7 -> 3.x upgrade.

Enabling Atom Feeds

A number of the power users on the FR forum used the previous RSS feed. This functionality has been dropped and an equivalent needs reinstituted. The previous mod implementation adopted the Simple RSS mod for phpBB3. However, this mod has significant limitations that I can't ignore; most importantly it bypasses the phpBB access control system, allowing unregistered users to browse closed forums. I didn't get this working properly but this functionality is now superseded by a standard php V306 feature to provide ATOM feeds.

  • We need to investigate its implementation for those forums that want it, as it requires enabling / configuring through ACP.
  • I need to discuss this further with the FR proponents of this mod.
  • Note that for some reason, the ATOM feed link isn't being displayed if the Feed is enable. I need to investigate this.

Basic Management Reporting

Some of the NL forums are clearly active and healthy. Some clearly less so. However, we have no objective measures in place to identify any issues that are arising and any trends that need to trigger additional support for any individual forum that might be having problems. One option here might be to introduce some basic health measures so that we can maintain a simple forum dashboard.

Standardising Forum Configurations

With 10 forums any degree of divergence can cause problems on upgrade and through-life maintenance, so we need to standardise where possible. I am not talking about language packs or basic forum structure but things like the extra BBcodes, permissible file extensions for upload, etc.. If they make sense in one OOo forum then they should be in all.

Write up phpBB 3.0.7 configuration

I have decided to do this in the phpBB wiki because this will be of more interest to phpBB admins rather than OOo Volunteers and NL Admins. I will post the link here when I've done it.

Personal tools