## - Sympa -- Integrate modlist/whitelist plugin
## -
## - See:
## -    http://www.steveshipway.org/software/f_sympa.html
## -

## - !! Notice !!
## -
## - For me in my installation modlist does not work (or i haven't unsertand
## - the use of modlist

VERSION=1.1
SYMPA_USER="sympa"
SYMPA_GROUP="sympa"
SYMPA_HOME=`realpath $(eval echo ~$SYMPA_USER)`

## - Download file whitelist-1.1.tar
## -
cd /usr/local/src/sympa/
wget http://www.steveshipway.org/software/sympa/whitelist-${VERSION}.tar

tar -xf whitelist-${VERSION}.tar

## ---
## - Copy the plugin-files to their appropriate targets
## ---
cd whitelist-${VERSION} 


## - 1. Copy whitelist.pm and modlist.pm to the custom_actions directory.
## -    These are the custom actions.  If you only copy the whitelist.pm then
## -    modlist functionality will be disabled.  Either put them at the top level,
## -    or at robot level as you prefer.
## -
cp -a custom_actions/whitelist.pm ${SYMPA_HOME}/etc/custom_actions/
#cp -a  modlist.pm ${SYMPA_HOME}/etc/custom_actions/
chown -R ${SYMPA_USER}:$SYMPA_GROUP ${SYMPA_HOME}/etc/custom_actions


## - 2. Create default empty whitelist.txt and modlist.txt files in
## -    search_filters (or wherever your Sympa search_filters path is).
## -    These must exist as a default for lists that do not have a defined whitelist
## -    or modlist.
## -
touch ${SYMPA_HOME}/etc/search_filters/whitelist.txt
touch ${SYMPA_HOME}/etc/search_filters/modlist.txt
chown -R ${SYMPA_USER}:$SYMPA_GROUP ${SYMPA_HOME}/etc/search_filters


## - 3. Install the whitelist.tt2 template into the web_tt2 directory.
## -    This is the admin pages for the whitelist and modlist.  It goes into
## -    your web_tt2 customisation directory.
## -
cp -a web_tt2/whitelist.tt2 ${SYMPA_HOME}/etc/web_tt2/
chown ${SYMPA_USER}:$SYMPA_GROUP ${SYMPA_HOME}/etc/web_tt2/whitelist.tt2


## - 4. Update nav.tt2 on your system.  This is where you add the new Whitelist
## -    and Modlist menu items.  The supplied nav.tt2 file
## -    should work with Sympa 6.2.x but if you have already customised nav.tt2
## -    you should make sure to add the necessary Whitelist and Modlist parts.
## -
cp -a web_tt2/nav.tt2 ${SYMPA_HOME}/etc/web_tt2/

## - If you only instlled whitelist functionality, you can comment in the
## - entry for modlist
## -
## - line 146, change to
## - <!-- <li class="[% class %]"><a  href="[% path_cgi %]/lca/modlist/[% list %]" >[%|loc%]Modlist[%END%]</a></li> -->
## -
cp -a ${SYMPA_HOME}/etc/web_tt2/nav.tt2 ${SYMPA_HOME}/etc/web_tt2/nav.tt2.ORIG
vim ${SYMPA_HOME}/etc/web_tt2/nav.tt2


## - 5. Update search.tt2 and review.tt2.  These add the Whitelist and Modlist
## -    buttons to the subscribers review page.  The supplied files
## -    should work with Sympa 6.2.x but if you have already customised them
## -    you should make sure to add the necessary Whitelist and Modlist parts.
## -
cp -a web_tt2/{search.tt2,review.tt2} ${SYMPA_HOME}/etc/web_tt2/

## - If you only instlled whitelist functionality, you can comment in the
## - entries for modlist
## -
## - search.tt2 line 12, change to
## - <!-- <a class="actionMenuLinks" href="[% path_cgi %]/lca/modlist/[% list %]">[%|loc%]Modlist[%END%]</a> -->
## -
## - review.tt2 line 12, change to
## - <!-- <a class="actionMenuLinks" href="[% path_cgi %]/lca/modlist/[% list %]">[%|loc%]Modlist[%END%]</a> -->
## - 
cp -a ${SYMPA_HOME}/etc/web_tt2/search.tt2 ${SYMPA_HOME}/etc/web_tt2/search.tt2.ORIG
vim ${SYMPA_HOME}/etc/web_tt2/search.tt2

cp -a ${SYMPA_HOME}/etc/web_tt2/review.tt2 ${SYMPA_HOME}/etc/web_tt2/review.tt2.ORIG
vim ${SYMPA_HOME}/etc/web_tt2/review.tt2


## - 6. Update admin.t22.  This adds the white/modlist options to the list admin
## -    page.  This is optional but recommended.
## -
cp -a web_tt2/admin.tt2 ${SYMPA_HOME}/etc/web_tt2/

## - If you only instlled whitelist functionality, you can comment in the
## - entry for modlist
## -
## - line 15, change to
## - <!-- <li><strong><a href="[% path_cgi %]/lca/modlist/[% list %]" >[%|loc%]Modlist:[%END%]</a></strong> [%|loc%]Handles the set of moderation-listed mail addresses for this list.[%END%]</li> -->
## -
cp -a ${SYMPA_HOME}/etc/web_tt2/admin.tt2 ${SYMPA_HOME}/etc/web_tt2/admin.tt2.ORIG
vim ${SYMPA_HOME}/etc/web_tt2/admin.tt2

chown -R ${SYMPA_USER}:$SYMPA_GROUP ${SYMPA_HOME}/etc/web_tt2


## -7. Copy include.send.header into your scenari directory.  This
## -   activates the Whitelist and Modlist on all lists, though until you define
## -   some entries, all lists will get the default empty files you set up in
## -   step 2.
## -
cp scenari/include.send.header ${SYMPA_HOME}/etc/scenari/
chown -R ${SYMPA_USER}:$SYMPA_GROUP ${SYMPA_HOME}/etc/scenari


## - 8. Restart the Sympa daemons, and restart your web server.  This will pick up
## -    the changes.
## -
/etc/init.d/sympa restart
systemctl restart sympa