Root/
<?php /* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* # ***** BEGIN LICENSE BLOCK ***** # This file is part of InDefero, an open source project management application. # Copyright (C) 2008-2011 Céondo Ltd and contributors. # # InDefero 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. # # InDefero 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 this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA # # ***** END LICENSE BLOCK ***** */ Pluf::loadFunction( 'Pluf_HTTP_URL_urlForView' ); Pluf::loadFunction( 'Pluf_Template_dateAgo' ); /** * Base definition of an issue. * * An issue can have labels, comments, can be starred by people. */ class IDF_Issue extends Pluf_Model { public $_model = __CLASS__ ; function init() { //$tagtbl = "indefero_idf_tags"; $this ->_a[ 'table' ] = 'idf_issues' ; $this ->_a[ 'model' ] = __CLASS__ ; $this ->_a[ 'cols' ] = array ( // It is mandatory to have an "id" column. 'id' => array ( 'type' => 'Pluf_DB_Field_Sequence' , 'blank' => true, ), 'project' => array ( 'type' => 'Pluf_DB_Field_Foreignkey' , 'model' => 'IDF_Project' , 'blank' => false, 'verbose' => __( 'project' ), 'relate_name' => 'issues' , ), 'summary' => array ( 'type' => 'Pluf_DB_Field_Varchar' , 'blank' => false, 'size' => 250, 'verbose' => __( 'summary' ), ), 'submitter' => array ( 'type' => 'Pluf_DB_Field_Foreignkey' , 'model' => 'Pluf_User' , 'blank' => false, 'verbose' => __( 'submitter' ), 'relate_name' => 'submitted_issue' , ), 'owner' => array ( 'type' => 'Pluf_DB_Field_Foreignkey' , 'model' => 'Pluf_User' , 'blank' => true, // no owner when submitted. 'is_null' => true, 'verbose' => __( 'owner' ), 'relate_name' => 'owned_issue' , ), 'interested' => array ( 'type' => 'Pluf_DB_Field_Manytomany' , 'model' => 'Pluf_User' , 'blank' => true, 'verbose' => __( 'interested users' ), 'help_text' => __( 'Interested users will get an email notification when the issue is changed.' ), ), 'tags' => array ( 'type' => 'Pluf_DB_Field_Manytomany' , 'blank' => true, 'model' => 'IDF_Tag' , 'verbose' => __( 'labels' ), ), 'status' => array ( 'type' => 'Pluf_DB_Field_Foreignkey' , 'blank' => false, 'model' => 'IDF_Tag' , 'verbose' => __( 'status' ), ), 'creation_dtime' => array ( 'type' => 'Pluf_DB_Field_Datetime' , 'blank' => true, 'verbose' => __( 'creation date' ), ), 'modif_dtime' => array ( 'type' => 'Pluf_DB_Field_Datetime' , 'blank' => true, 'verbose' => __( 'modification date' ), ), ); $this ->_a[ 'idx' ] = array ( 'modif_dtime_idx' => array ( 'col' => 'modif_dtime' , 'type' => 'normal' , ), ); $table = $this ->_con->pfx. 'idf_issue_idf_tag_assoc' ; $tagtbl = $this ->_con->pfx . "idf_tags" ; $projtbl = $this ->_con->pfx . "idf_projects" ; $this ->_a[ 'views' ] = array ( 'project_find' => array ( 'where' => '( lcname = "new" or lcname = "accepted" or lcname = "started" )' , 'join' => "INNER JOIN " . $tagtbl . " on " . $this ->getSqlTable() . ".status = " . $tagtbl . ".id" ), 'project_find_open' => array ( 'where' => '( lcname = "new" or lcname = "accepted" or lcname = "started" )' , 'join' => "INNER JOIN " . $tagtbl . " on " . $this ->getSqlTable() . ".status = " . $tagtbl . ".id" ), 'project_find_closed' => array ( 'where' => '( lcname = "fixed" or lcname = "verified" or lcname = "invalid" or lcname = "wontfix" )' , 'join' => "INNER JOIN " . $tagtbl . " on " . $this ->getSqlTable() . ".status = " . $tagtbl . ".id" ), 'project_find_private' => array ( 'where' => 'private = 0 AND ( lcname = "new" or lcname = "accepted" or lcname = "started" )' , 'join' => "INNER JOIN " . $tagtbl . " on " . $this ->getSqlTable() . ".status = " . $tagtbl . ".id INNER JOIN " . $projtbl . " ON " . $this ->getSqlTable() . ".project = " . $projtbl . ".id" ), 'join_tags' => array ( 'join' => 'LEFT JOIN ' . $table . ' ON idf_issue_id=id' , ), ); } function __toString() { return $this ->id. ' - ' . $this ->summary; } function _toIndex() { $r = array (); foreach ( $this ->get_comments_list() as $c ) { $r [] = $c ->_toIndex(); } $str = str_repeat ( $this ->summary. ' ' , 4). ' ' .implode( ' ' , $r ); return Pluf_Text::cleanString(html_entity_decode( $str , ENT_QUOTES, 'UTF-8' )); } function preDelete() { IDF_Timeline::remove( $this ); IDF_Search::remove( $this ); } function preSave( $create =false) { if ( $this ->id == '' ) { $this ->creation_dtime = gmdate ( 'Y-m-d H:i:s' ); } $this ->modif_dtime = gmdate ( 'Y-m-d H:i:s' ); } function postSave( $create =false) { // Note: No indexing is performed here. The indexing is // triggered in the postSave step of the comment to ensure // that the issue as at least one comment in the database when // doing the indexing. if ( $create ) { IDF_Timeline::insert( $this , $this ->get_project(), $this ->get_submitter()); } } function getGroupedRelatedIssues( $opts = array (), $idsOnly = false) { $rels = $this ->get_related_issues_list( array_merge ( $opts , array ( 'view' => 'with_other_issue' , ))); $res = array (); foreach ( $rels as $rel ) { $verb = $rel ->verb; if (! array_key_exists ( $verb , $res )) { $res [ $verb ] = array (); } $res [ $verb ][] = $idsOnly ? $rel ->other_issue : $rel ; } return $res ; } /** * Returns an HTML fragment used to display this issue in the * timeline. * * The request object is given to be able to check the rights and * as such create links to other items etc. You can consider that * if displayed, you can create a link to it. * * @param Pluf_HTTP_Request * @return Pluf_Template_SafeString */ public function timelineFragment( $request ) { $url = Pluf_HTTP_URL_urlForView( 'IDF_Views_Issue::view' , array ( $request ->project->shortname, $this ->id)); $out = '<tr class="log"><td><a href="' . $url . '">' . Pluf_esc(Pluf_Template_dateAgo( $this ->creation_dtime, 'without' )). '</a></td><td>' ; $stag = new IDF_Template_ShowUser(); $user = $stag ->start( $this ->get_submitter(), $request , '' , false); $ic = (in_array( $this ->status, $request ->project->getTagIdsByStatus( 'closed' ))) ? 'issue-c' : 'issue-o' ; $out .= sprintf(__( '<a href="%1$s" class="%2$s" title="View issue">Issue %3$d</a>, %4$s' ), $url , $ic , $this ->id, Pluf_esc( $this ->summary)). '</td>' ; $out .= "\n" .'<tr class = "extra" ><td colspan= "2" > <div class = "helptext right" > '.sprintf(__(' Creation of <a href= "%1$s" class = "%2$s" >issue %3 $d </a>, by %4 $s '), $url, $ic, $this->id, $user).' </div></td></tr>'; return Pluf_Template::markSafe( $out ); } public function feedFragment( $request ) { $url = Pluf::f( 'url_base' ) .Pluf_HTTP_URL_urlForView( 'IDF_Views_Issue::view' , array ( $request ->project->shortname, $this ->id)); $title = sprintf(__( '%1$s: Issue %2$d created - %3$s' ), $request ->project->name, $this ->id, $this ->summary); $cts = $this ->get_comments_list( array ( 'order' => 'id ASC' , 'nb' => 1)); $date = Pluf_Date::gmDateToGmString( $this ->creation_dtime); $context = new Pluf_Template_Context_Request( $request , array ( 'url' => $url , 'author' => $this ->get_submitter(), 'title' => $title , 'c' => $cts [0], 'issue' => $this , 'date' => $date ) ); $tmpl = new Pluf_Template( 'idf/issues/feedfragment.xml' ); return $tmpl ->render( $context ); } /** * Notification of change of the object. * * For the moment, only email, but one can add webhooks later. * * Usage: * <pre> * $this->notify($conf); // Notify the creation * $this->notify($conf, false); // Notify the update of the object * </pre> * * @param IDF_Conf Current configuration * @param bool Creation (true) */ public function notify( $conf , $create =true) { $project = $this ->get_project(); $current_locale = Pluf_Translation::getLocale(); $from_email = Pluf::f( 'from_email' ); $comments = $this ->get_comments_list( array ( 'order' => 'id DESC' )); $messageId = '<' .md5( 'issue' . $this ->id.md5(Pluf::f( 'secret_key' ))). '@' .Pluf::f( 'mail_host' , 'localhost' ). '>' ; $recipients = $project ->getNotificationRecipientsForTab( 'issues' ); // the submitter (might be skipped later on if he is the one who also // submitted the last comment) if (! array_key_exists ( $this ->get_submitter()->email, $recipients )) { $recipients [ $this ->get_submitter()->email] = $this ->get_submitter()->language; } // the owner of the issue, if we have one $owner = $this ->get_owner(); if (null != $owner && ! array_key_exists ( $owner ->email, $recipients )) { $recipients [ $owner ->email] = $owner ->language; } // additional users who starred the issue foreach ( $this ->get_interested_list() as $interested ) { if ( array_key_exists ( $interested ->email, $recipients )) continue ; $recipients [ $interested ->email] = $interested ->language; } foreach ( $recipients as $address => $language ) { // do not notify the creator of the last comment, // i.e. the user who triggered this notification if ( $comments [0]->get_submitter()->email === $address ) { continue ; } Pluf_Translation::loadSetLocale( $language ); $context = new Pluf_Template_Context( array ( 'issue' => $this , 'owns_issue' => $owner !== null && $owner ->email === $address , // the initial comment for create, the last for update 'comment' => $comments [0], 'comments' => $comments , 'project' => $project , 'url_base' => Pluf::f( 'url_base' ), )); $tplfile = 'idf/issues/issue-created-email.txt' ; $subject = __( 'Issue %1$s - %2$s (%3$s)' ); $headers = array ( 'Message-ID' => $messageId ); if (! $create ) { $tplfile = 'idf/issues/issue-updated-email.txt' ; $subject = __( 'Updated Issue %1$s - %2$s (%3$s)' ); $headers = array ( 'References' => $messageId ); } $tmpl = new Pluf_Template( $tplfile ); $text_email = $tmpl ->render( $context ); $email = new Pluf_Mail( $from_email , $address , sprintf( $subject , $this ->id, $this ->summary, $project ->shortname)); $email ->addTextMessage( $text_email ); $email ->addHeaders( $headers ); $email ->sendMail(); } Pluf_Translation::loadSetLocale( $current_locale ); } } |