X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=include%2Fnewsletter.inc.php;h=2f6ccca41fb87c5f2bd5a8bd8a4afec49bf89659;hb=285e2fe72d086ae94fc95696a0cefc8755113277;hp=da97493d4a03fa379c359a3e6026a076de764680;hpb=6c21094e45512da7fb1321a1df4335b1d48ed9bd;p=platal.git diff --git a/include/newsletter.inc.php b/include/newsletter.inc.php index da97493..2f6ccca 100644 --- a/include/newsletter.inc.php +++ b/include/newsletter.inc.php @@ -47,6 +47,11 @@ class NewsLetter const GROUP_AX = 'AX'; const GROUP_EP = 'Ecole'; + // Searches on mutiple fields + const SEARCH_ALL = 'all'; + const SEARCH_TITLE = 'title'; + + // {{{ Constructor, NewsLetter retrieval (forGroup, getAll) public function __construct($id) @@ -174,7 +179,7 @@ class NewsLetter } } - return new NLIssue($id, &$this); + return new NLIssue($id, $this); } /** Create a new, empty, pending newsletter issue @@ -251,6 +256,63 @@ class NewsLetter } } + /** Returns a list of either issues or articles corresponding to the search. + * @p $search The searched pattern. + * @p $field The fields where to search, if none given, search in all possible fields. + * @return The list of object found. + */ + public function issueSearch($search, $field, $user) + { + $search = XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $search); + if ($field == self::SEARCH_ALL) { + $where = '(title ' . $search . ' OR mail_title ' . $search . ' OR head ' . $search . ' OR signature ' . $search . ')'; + } elseif ($field == self::SEARCH_TITLE) { + $where = '(title ' . $search . ' OR mail_title ' . $search . ')'; + } else { + $where = $field . $search; + } + $list = XDB::fetchColumn('SELECT DISTINCT(id) + FROM newsletter_issues + WHERE nlid = {?} AND state = \'sent\' AND ' . $where . ' + ORDER BY date DESC', + $this->id); + + $issues = array(); + foreach ($list as $id) { + $issue = new NLIssue($id, $this, false); + if ($issue->checkUser($user)) { + $issues[] = $issue; + } + } + return $issues; + } + + public function articleSearch($search, $field, $user) + { + $search = XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $search); + if ($field == self::SEARCH_ALL) { + $where = '(a.title ' . $search . ' OR a.body ' . $search . ' OR a.append ' . $search . ')'; + } else { + $where = 'a.' . $field . $search; + } + $list = XDB::fetchAllAssoc('SELECT i.short_name, a.aid, i.id, a.title + FROM newsletter_art AS a + INNER JOIN newsletter_issues AS i ON (a.id = i.id) + WHERE i.nlid = {?} AND i.state = \'sent\' AND ' . $where . ' + GROUP BY a.id, a.aid + ORDER BY i.date DESC, a.aid', + $this->id); + + $articles = array(); + foreach ($list as $item) { + $issue = new NLIssue($item['id'], $this, false); + if ($issue->checkUser($user)) { + $articles[] = $item; + } + } + return $articles; + } + // }}} // {{{ Subscription related function @@ -259,7 +321,7 @@ class NewsLetter * @p $hash True if the uid is actually a hash. * @return True if the user was successfully unsubscribed. */ - public function unsubscribe($uid = null, $hash = false) + public function unsubscribe($issue_id = null, $uid = null, $hash = false) { if (is_null($uid) && $hash) { // Unable to unsubscribe from an empty hash @@ -280,6 +342,12 @@ class NewsLetter XDB::execute('DELETE FROM newsletter_ins WHERE nlid = {?} AND uid = {?}', $this->id, $user); + if (!is_null($issue_id)) { + XDB::execute('UPDATE newsletter_issues + SET unsubscribe = unsubscribe + 1 + WHERE id = {?}', + $id); + } return true; } @@ -298,6 +366,21 @@ class NewsLetter } } + /** Subscribe a batch of users to a newsletter. + * This skips 'maySubscribe' test. + * + * @p $user_ids Array of user IDs to subscribe to the newsletter. + */ + public function bulkSubscribe($user_ids) + { + // TODO: use a 'bulkMaySubscribe'. + XDB::execute('INSERT IGNORE INTO newsletter_ins (nlid, uid, last, hash) + SELECT {?}, a.uid, NULL, NULL + FROM accounts AS a + WHERE a.uid IN {?}', + $this->id, $user_ids); + } + /** Retrieve subscription state of a user * @p $user Target user; if null, use current user. * @return Boolean: true if the user has subscribed to the NL. @@ -433,10 +516,14 @@ class NewsLetter /** Get the prefix leading to the page for this NL * Only X.org / AX / X groups may be seen on X.org. */ - public function prefix() + public function prefix($enforce_xnet=true, $with_group=true) { if (!empty($GLOBALS['IS_XNET_SITE'])) { - return $this->group . '/nl'; + if ($with_group) { + return $this->group . '/nl'; + } else { + return 'nl'; + } } switch ($this->group) { case self::GROUP_XORG: @@ -447,16 +534,20 @@ class NewsLetter return 'epletter'; default: // Don't display groups NLs on X.org - assert(false); + assert(!$enforce_xnet); } } /** Get the prefix to use for all 'admin' pages of this NL. */ - public function adminPrefix() + public function adminPrefix($enforce_xnet=true, $with_group=true) { if (!empty($GLOBALS['IS_XNET_SITE'])) { - return $this->group . '/admin/nl'; + if ($with_group) { + return $this->group . '/admin/nl'; + } else { + return 'admin/nl'; + } } switch ($this->group) { case self::GROUP_XORG: @@ -467,7 +558,7 @@ class NewsLetter return 'epletter/admin'; default: // Don't display groups NLs on X.org - assert(false); + assert(!$enforce_xnet); } } @@ -491,6 +582,18 @@ class NewsLetter return $this->custom_css; } + public function canSyncWithGroup() + { + switch ($this->group) { + case self::GROUP_XORG: + case self::GROUP_AX: + case self::GROUP_EP: + return false; + default: + return true; + } + } + // }}} } @@ -558,6 +661,7 @@ class NLIssue $this->nl = new NewsLetter($issue['nlid']); } $this->id = $id; + $this->nlid = $issue['nlid']; $this->shortname = $issue['short_name']; $this->date = $issue['date']; $this->send_before = $issue['send_before']; @@ -666,6 +770,11 @@ class NLIssue WHERE id = {?}', $this->id); if ($success) { + global $globals; + $mailer = new PlMailer('newsletter/notify_scheduled.mail.tpl'); + $mailer->assign('issue', $this); + $mailer->assign('base', $globals->baseurl); + $mailer->send(); $this->refresh(); } return $success; @@ -681,7 +790,7 @@ class NLIssue { if ($this->state == self::STATE_PENDING) { $success = XDB::execute('UPDATE newsletter_issues - SET send_before = NULL, state = \'new\' + SET state = \'new\' WHERE id = {?}', $this->id); if ($success) { $this->refresh(); @@ -751,7 +860,11 @@ class NLIssue public function last() { if (is_null($this->id_last)) { - $this->id_last = $this->nl->getIssue('last')->id; + try { + $this->id_last = $this->nl->getIssue('last')->id; + } catch (MailNotFound $e) { + $this->id_last = null; + } } return $this->id_last; } @@ -761,6 +874,7 @@ class NLIssue const ERROR_INVALID_SHORTNAME = 'invalid_shortname'; const ERROR_INVALID_UFC = 'invalid_ufc'; + const ERROR_TOO_LONG_UFC = 'too_long_ufc'; const ERROR_SQL_SAVE = 'sql_error'; /** Save the global properties of this NL issue (title&co). @@ -786,6 +900,11 @@ class NLIssue } if ($this->sufb->isValid() || $this->sufb->isEmpty()) { $fields['sufb_json'] = json_encode($this->sufb->export()->dict()); + // If sufb_json is too long to be store, we do not store a truncated json and notify the user. + // The limit is LONGTEXT's one, ie 2^32 = 4294967296. + if (strlen($fields['sufb_json']) > 4294967295) { + $errors[] = self::ERROR_TOO_LONG_UFC; + } } else { $errors[] = self::ERROR_INVALID_UFC; } @@ -831,9 +950,9 @@ class NLIssue } /** Save an article - * @p &$a A reference to a NLArticle object (will be modified once saved) + * @p $a A reference to a NLArticle object (will be modified once saved) */ - public function saveArticle(&$a) + public function saveArticle($a) { $this->fetchArticles(); @@ -927,7 +1046,7 @@ class NLIssue * @p $page Smarty object * @return Either 'true' (if CSS was added to a page) or the raw CSS to add (when $page is null) */ - public function css(&$page = null) + public function css($page = null) { if (!is_null($page)) { $page->addCssLink($this->nl->cssFile()); @@ -942,7 +1061,7 @@ class NLIssue * @p $page Smarty object (using the $this->nl->tplFile() template) * @p $user User to use when rendering the template */ - public function toText(&$page, $user) + public function toText($page, $user) { $this->fetchArticles(); @@ -959,7 +1078,7 @@ class NLIssue * @p $page Smarty object (using the $this->nl->tplFile() template) * @p $user User to use when rendering the template */ - public function toHtml(&$page, $user) + public function toHtml($page, $user) { $this->fetchArticles(); @@ -975,7 +1094,7 @@ class NLIssue /** Set all 'common' data for the page (those which are required for both web and email rendering) * @p $smarty Smarty object (e.g page) which should be filled */ - protected function assignData(&$smarty) + protected function assignData($smarty) { $this->fetchArticles(); @@ -985,7 +1104,15 @@ class NLIssue // }}} // {{{ Mailing - + + /** Check whether this issue is empty + * An issue is empty if the email has no title (or the default one), or no articles and an empty head. + */ + public function isEmpty() + { + return $this->title_mail == '' || $this->title_mail == 'to be continued' || (count($this->arts) == 0 && strlen($this->head) == 0); + } + /** Retrieve the 'Send before' date, in a clean format. */ public function getSendBeforeDate() @@ -1077,21 +1204,24 @@ class NLIssue WHERE id = {?}', $this->id); - $ufc = new PFC_And($this->getRecipientsUFC(), new UFC_NLSubscribed($this->nl->id, $this->id), new UFC_HasEmailRedirect()); - $emailsCount = 0; - $uf = new UserFilter($ufc); + $ufc = new PFC_And($this->getRecipientsUFC(), new UFC_NLSubscribed($this->nl->id, $this->id), new UFC_HasValidEmail()); + $uf = new UserFilter($ufc, array(new UFO_IsAdmin(), new UFO_Uid())); $limit = new PlLimit(self::BATCH_SIZE); + $global_sent = array(); while (true) { $sent = array(); $users = $uf->getUsers($limit); if (count($users) == 0) { - return $emailsCount; + break; } foreach ($users as $user) { + if (array_key_exists($user->id(), $global_sent)) { + Platal::kill('Sending the same newsletter issue ' . $this->id . ' to user ' . $user->id() . ' twice, something must be wrong.'); + } $sent[] = $user->id(); + $global_sent[$user->id()] = true; $this->sendTo($user, $hash); - ++$emailsCount; } XDB::execute("UPDATE newsletter_ins SET last = {?} @@ -1099,7 +1229,7 @@ class NLIssue sleep(60); } - return $emailsCount; + return count($global_sent); } // }}} @@ -1111,7 +1241,8 @@ class NLIssue class NLArticle { // Maximum number of lines per article - const MAX_LINES_PER_ARTICLE = 9; + const MAX_LINES_PER_ARTICLE = 8; + const MAX_CHARACTERS_PER_LINE = 68; // {{{ properties @@ -1199,17 +1330,30 @@ class NLArticle public function check() { - $text = MiniWiki::WikiToText($this->body); - $arr = explode("\n",wordwrap($text,68)); - $c = 0; - foreach ($arr as $line) { - if (trim($line)) { - $c++; + $rest = $this->remain(); + + return $rest['remaining_lines'] >= 0; + } + + // }}} + // {{{ function remain() + + public function remain() + { + $text = MiniWiki::WikiToText($this->body); + $array = explode("\n", wordwrap($text, self::MAX_CHARACTERS_PER_LINE)); + $lines_count = 0; + foreach ($array as $line) { + if (trim($line) != '') { + ++$lines_count; } } - return $c < self::MAX_LINES_PER_ARTICLE; - } + return array( + 'remaining_lines' => self::MAX_LINES_PER_ARTICLE - $lines_count, + 'remaining_characters_for_last_line' => self::MAX_CHARACTERS_PER_LINE - strlen($array[count($array) - 1]) + ); + } // }}} // {{{ function parseUrlsFromArticle()