Indefero

Indefero Git Source Tree


Root/src/IDF/Issue.php

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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
<?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 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()
    {
        $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';
        $this->_a['views'] = array(
                              '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());
        }
    }
 
    /**
     * 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="%s" class="%s">issue %d</a>, by %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(__('%s: Issue %d created - %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)
    {
        $prj = $this->get_project();
        $to_email = array();
        if ('' != $conf->getVal('issues_notification_email', '')) {
            $langs = Pluf::f('languages', array('en'));
            $to_email[] = array($conf->getVal('issues_notification_email'),
                                $langs[0]);
        }
        $current_locale = Pluf_Translation::getLocale();
        $id = '<'.md5($this->id.md5(Pluf::f('secret_key'))).'@'.Pluf::f('mail_host', 'localhost').'>';
        if ($create) {
            if (null != $this->get_owner() and $this->owner != $this->submitter) {               
                $email_lang = array($this->get_owner()->email,
                                    $this->get_owner()->language);
                if (!in_array($email_lang, $to_email)) {
                    $to_email[] = $email_lang;
                }
            }
            $comments = $this->get_comments_list(array('order' => 'id ASC'));
            $context = new Pluf_Template_Context(
                                   array(
                                         'issue' => $this,
                                         'comment' => $comments[0],
                                         'project' => $prj,
                                         'url_base' => Pluf::f('url_base'),
                                         )
                                                 );
            foreach ($to_email as $email_lang) {
                Pluf_Translation::loadSetLocale($email_lang[1]);
                $email = new Pluf_Mail(Pluf::f('from_email'), $email_lang[0],
                                       sprintf(__('Issue %s - %s (%s)'),
                                               $this->id, $this->summary, $prj->shortname));
                $tmpl = new Pluf_Template('idf/issues/issue-created-email.txt');
                $email->addTextMessage($tmpl->render($context));
                $email->addHeaders(array('Message-ID'=>$id));
                $email->sendMail();
            }
        } else {
            $comments = $this->get_comments_list(array('order' => 'id DESC'));
            $email_sender = '';
            if (isset($comments[0])) {
                $email_sender = $comments[0]->get_submitter()->email;
            }
            foreach ($this->get_interested_list() as $interested) {
                $email_lang = array($interested->email,
                                    $interested->language);
                if (!in_array($email_lang, $to_email)) {
                    $to_email[] = $email_lang;
                }
            }
            $email_lang = array($this->get_submitter()->email,
                                $this->get_submitter()->language);
            if (!in_array($email_lang, $to_email)) {
                $to_email[] = $email_lang;
            }
            if (null != $this->get_owner()) {
                $email_lang = array($this->get_owner()->email,
                                    $this->get_owner()->language);
                if (!in_array($email_lang, $to_email)) {
                    $to_email[] = $email_lang;
                }
            }
            $context = new Pluf_Template_Context(
                            array(
                                  'issue' => $this,
                                  'comments' => $comments,
                                  'project' => $prj,
                                  'url_base' => Pluf::f('url_base'),
                                  ));
            foreach ($to_email as $email_lang) {
                if ($email_lang[0] == $email_sender) {
                    continue; // Do not notify the one having created
                              // the comment
                }
                Pluf_Translation::loadSetLocale($email_lang[1]);
                $email = new Pluf_Mail(Pluf::f('from_email'), $email_lang[0],
                                       sprintf(__('Updated Issue %s - %s (%s)'),
                                               $this->id, $this->summary, $prj->shortname));
                $tmpl = new Pluf_Template('idf/issues/issue-updated-email.txt');
                $email->addTextMessage($tmpl->render($context));
                $email->addHeaders(array('References'=>$id));
                $email->sendMail();
            }
        }
        Pluf_Translation::loadSetLocale($current_locale);
    }
}

Archive Download this file

Page rendered in 0.11986s using 11 queries.