File: BackendMailmanList.class.php

package info (click to toggle)
fusionforge 5.3.2%2B20141104-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 60,472 kB
  • sloc: php: 271,846; sql: 36,817; python: 14,575; perl: 6,406; sh: 5,980; xml: 4,294; pascal: 1,411; makefile: 911; cpp: 52; awk: 27
file content (191 lines) | stat: -rw-r--r-- 6,694 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<?php
/**
 * Copyright (c) Xerox Corporation, Codendi Team, 2001-2009. All rights reserved
 *
 * This file is a part of Codendi.
 *
 * Codendi is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Codendi 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Codendi. If not, see <http://www.gnu.org/licenses/>.
 *
 * Portions Copyright 2010 (c) Mélanie Le Bail
 */

require_once 'common/event/Event.class.php';
require_once 'mailman/include/MailmanListDao.class.php';
require_once 'common/dao/CodendiDataAccess.class.php';
require_once 'mailman/include/MailmanList.class.php';
require_once 'plugins_utils.php';
require_once 'plugins/mailman/config.php';

class BackendMailmanList {

    protected $_mailinglistdao = null;

    /**
     * Hold an instance of the class
     */
    protected static $_instance;

    /**
     * Backends are singletons
     */
    public static function instance() {

        if (!isset(self::$_instance)) {
            $c = __CLASS__;
            self::$_instance = new $c;
        }
        return self::$_instance;
    }

    /**
     * @return MailingListDao
     */
    protected function _getMailingListDao() {
        if (!$this->_mailinglistdao) {
          $this->_mailinglistdao = new MailmanListDao(CodendiDataAccess::instance());
        }
        return $this->_mailinglistdao;
    }

    /**
     * Update mailman configuration for the given list
     * Write configuration in temporary file, and load it with mailman config_list tool
     * @return true on success, false otherwise
     */
    protected function updateListConfig($list) {
        // write configuration in temporary file
        $config_file=$GLOBALS['tmp_dir']."/mailman_config_".$list->getID().".in";

        if ($fp = fopen($config_file, 'w')) {
            // Define encoding of this file for Python. See SR #764
            // Please note that this allows config_list to run with UTF-8 strings, but if the
            // description contains non-ascii chars, they will be displayed badly in mailman config web page.
            fwrite($fp, "# coding=UTF-8\n\n");
            // Deactivate monthly reminders by default
            fwrite($fp, "send_reminders = 0\n");
            // Setup the description
            fwrite($fp, "description = '".addslashes($list->getDescription())."'\n");
            // Allow up to 200 kB messages
            fwrite($fp, "max_message_size = 200\n");

            if ($list->isPublic() == 0) { // Private lists
                // Don't advertise this list when people ask what lists are on this machine
                fwrite($fp, "advertised = False\n");
                // Private archives
                fwrite($fp, "archive_private = 1\n");
                // Subscribe requires approval
                fwrite($fp, "subscribe_policy = 2\n");
            }
            fclose($fp);

            if (system($GLOBALS['mailman_bin_dir']."/config_list -i $config_file ".$list->getName()) !== false) {
                if (unlink($config_file)) {
			return true;
                }
            }
        }
        return false;
    }


    /**
     * Create new mailing list with mailman 'newlist' tool
     * then update the list configuration according to list settings
     * @return true on success, false otherwise
     */
    public function createList($group_list_id) {

        $dar = $this->_getMailingListDao()->searchByGroupListId($group_list_id);

        if ($row = $dar->getRow()) {
            $list = new MailmanList($row['group_id'],$row['group_list_id']);
            $user=UserManager::instance()->getUserByID($list->getListAdminId());
	    $list_admin_email= $user->getEmail();
            $list_dir = $GLOBALS['mailman_lib_dir']."/lists/".$list->getName();

	    if($list->isPublic() != 9) {
		    if ((! is_dir($list_dir))) {
			    // Create list
			    system($GLOBALS['mailman_bin_dir']."/newlist -q ".$list->getName()." ".$list_admin_email." ".$list->getPassword()." >/dev/null");
			    // Then update configuraion
			    if( is_dir($list_dir) && $this->updateListConfig($list) !=false ) {
				    $result = $this->_getMailingListDao() -> updateList($list->getID(),$row['group_id'], $list->getDescription(), $list->isPublic(),'3');
				    if (!$result) {
					    printf('Unable to update the list status: '.db_error());
					    return false;
				    }
				    else {
					    return true;
				    }
			    }
			    else {
				    return false;
			    }
		    }
		    else {
			    $result = $this->_getMailingListDao() -> updateList($list->getID(),$row['group_id'], $list->getDescription(), $list->isPublic(),'3');
			    if (!$result) {
				    printf('Unable to update the list status: '.db_error());
				    return false;
			    }
			    else {
				    return true;
			    }
		    }
	    }
	}
	return false;
    }

    /**
     * Delete mailing list
     * - list and archives are deleted
     * - backup first in temp directory
     * @return true on success, false otherwise
     */
    public function deleteList($group_list_id) {
	    $dar = $this->_getMailingListDao()->searchByGroupListId($group_list_id);

	    if ($row = $dar->getRow()) {
		    $list=new MailmanList($row['group_id'],$group_list_id);
		    $list_dir = $GLOBALS['mailman_lib_dir']."/lists/".$list->getName();
		    if ((is_dir($list_dir))&&($list->isPublic() == 9)) {

			    // Archive first
			    $list_archive_dir = $GLOBALS['mailman_lib_dir']."/archives/private/".$list->getName(); // Does it work? TODO
			    $backupfile=$GLOBALS['mailman_lib_dir']."/archives/".$list->getName()."-mailman.tgz";
			    system("tar cfz $backupfile $list_dir $list_archive_dir");
			    chmod($backupfile,0600);

			    // Delete the mailing list if asked to and the mailing exists (archive deleted as well)
			    system($GLOBALS['mailman_bin_dir']. '/rmlist -a '. $list->getName() .' >/dev/null');

			    return true;
		    }
	    }
	    return false;
    }

    /**
     * Check if the list exists on the file system
     * @return true if list exists, false otherwise
     */
    public function listExists($list) {
	    // Is this the best test?
	    $list_dir = $GLOBALS['mailman_lib_dir']."/lists/".$list->getName();
	    if (! is_dir($list_dir)) return false;
	    return true;
    }

}