Passed
Pull Request — master (#5717)
by David
10:09
created

pm_form_page()   C

Complexity

Conditions 13
Paths 84

Size

Total Lines 87
Code Lines 66

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 13
eloc 66
nc 84
nop 3
dl 0
loc 87
rs 6.0351
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
// This file is part of BOINC.
3
// http://boinc.berkeley.edu
4
// Copyright (C) 2008 University of California
5
//
6
// BOINC is free software; you can redistribute it and/or modify it
7
// under the terms of the GNU Lesser General Public License
8
// as published by the Free Software Foundation,
9
// either version 3 of the License, or (at your option) any later version.
10
//
11
// BOINC is distributed in the hope that it will be useful,
12
// but WITHOUT ANY WARRANTY; without even the implied warranty of
13
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14
// See the GNU Lesser General Public License for more details.
15
//
16
// You should have received a copy of the GNU Lesser General Public License
17
// along with BOINC.  If not, see <http://www.gnu.org/licenses/>.
18
19
require_once("boinc_db.inc");
20
require_once("sanitize_html.inc");
21
require_once("bbcode_html.inc");
22
23
function pm_header() {
24
    echo "<div>\n";
25
    echo "    <a href=\"pm.php?action=inbox\">".tra("Inbox")."</a>\n";
26
    echo "    &middot; <a href=\"pm.php?action=new\">".tra("Write")."</a>\n";
27
    echo "</div>\n";
28
}
29
30
function pm_rules() {
31
    if (defined('PM_RULES')) return PM_RULES;
32
    $x = "<table><tr><td align=left><small>";
33
    $x .= tra("
34
        <ul>
35
        <li> Messages may not contain content that is obscene, hate-related,
36
            sexually explicit or suggestive.
37
        <li> No commercial advertisements.
38
        <li> No links to web sites involving sexual content,
39
            gambling, or intolerance of others.
40
        <li> No messages intended to annoy or antagonize other people.
41
        <li> No messages that are deliberately hostile, threatening, or insulting.
42
        <li> No abusive comments involving race, religion,
43
            nationality, gender, class or sexuality.
44
        <li> The privileges of violators may be suspended or revoked.
45
        <li> If your account is suspended, don't create a new one.
46
        </ul>
47
    ");
48
    $x .= "</small></td></tr></table>\n";
49
    return $x;
50
}
51
52
function pm_team_form($user, $teamid, $error=null) {
53
    global $bbcode_html, $bbcode_js;
54
    $team = BoincTeam::lookup_id($teamid);
55
    if (!$team) {
56
        error_page("no such team");
57
    }
58
    if (!is_team_admin($user, $team)) {
59
        error_page("not admin");
60
    }
61
62
    page_head(tra("Send message to team"),'','','', $bbcode_js);
63
64
    $subject = post_str("subject", true);
65
    $content = post_str("content", true);
66
    if (post_str("preview", true) == tra("Preview")) {
67
        panel(tra('Preview'),
68
            function() use($content) {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after USE keyword; found 0
Loading history...
69
                echo output_transform($content, null);
70
            }
71
        );
72
    }
73
    if ($error) {
74
        echo "<p class=\"text-danger\">".$error."</p>\n";
75
    }
76
77
    echo "<form action=\"pm.php\" method=\"post\" name=\"post\" onsubmit=\"return checkForm(this)\">\n";
78
    echo "<input type=\"hidden\" name=\"action\" value=\"send\">\n";
79
    echo "<input type=\"hidden\" name=\"teamid\" value=\"$teamid\">\n";
80
    echo form_tokens($user->authenticator);
81
    start_table();
82
    row2(
83
        tra("Subject"),
84
        "<input type=\"text\" class=\"form-control\" name=\"subject\" value=\"$subject\">",
85
        null, '20%'
86
    );
87
    row2_init(tra("Message")."<small>".bbcode_info()."</small>", '20%');
88
    start_table();
89
    echo $bbcode_html;
90
    echo "<tr><td>\n";
91
    echo "<textarea name=\"content\" class=\"form-control\" rows=\"18\">$content</textarea>";
92
    echo "</td></tr>\n";
93
    end_table();
94
    echo sprintf(
95
        '<tr><td></td><td>
96
        <input class="btn" %s type="submit" name="preview" value="%s">
97
        <input class="btn" %s type="submit" value="%s">
98
        </td></tr>
99
        ',
100
        button_style('blue'),
101
        tra("Preview"),
102
        button_style(),
103
        tra("Send message")
104
    );
105
    end_table();
106
    page_tail();
107
}
108
109
// show the send-PM page, possibly with an error message
110
//
111
function pm_form_page($replyto, $userid, $error = null) {
112
    global $bbcode_html, $bbcode_js;
113
    global $g_logged_in_user;
114
    page_head(tra("Send private message"),'','','', $bbcode_js);
115
116
    if (post_str("preview", true) == tra("Preview")) {
117
        $content = post_str("content", true);
118
        panel(tra('Preview'),
119
            function() use($content) {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after USE keyword; found 0
Loading history...
120
                echo output_transform($content, null);
121
            }
122
        );
123
    }
124
125
    $subject = '';
126
    $content = '';
127
    if ($replyto) {
128
        $message = BoincPrivateMessage::lookup_id($replyto);
129
        if (!$message || $message->userid != $g_logged_in_user->id) {
130
            error_page(tra("no such message"));
131
        }
132
        $content = "[quote]".$message->content."[/quote]\n";
133
        $userid = $message->senderid;
134
        $user = BoincUser::lookup_id($userid);
135
        if (!$user) {
136
            error_page("Sender no longer exists");
137
        }
138
        $writeto = UNIQUE_USER_NAME?$user->name:$userid." (".$user->name.")";
139
        $subject = $message->subject;
140
        if (substr($subject, 0, 3) != "re:") {
141
            $subject = "re: ".$subject;
142
        }
143
    } elseif ($userid) {
144
        $user = BoincUser::lookup_id($userid);
145
        if (!$user) {
146
            error_page("Sender no longer exists");
147
        }
148
        $writeto = UNIQUE_USER_NAME?$user->name:$userid." (".$user->name.")";
149
    } else {
150
        $writeto = sanitize_tags(post_str("to", true));
151
        $subject = post_str("subject", true);
152
        $content = post_str("content", true);
153
    }
154
155
    $content = htmlspecialchars($content);
156
    $subject = htmlspecialchars($subject);
157
158
    if ($error != null) {
159
        echo "<p class=\"text-danger\">".$error."</p>\n";
160
    }
161
162
    echo "<form action=\"pm.php\" method=\"post\" name=\"post\" onsubmit=\"return checkForm(this)\">\n";
163
    echo "<input type=\"hidden\" name=\"action\" value=\"send\">\n";
164
    echo form_tokens($g_logged_in_user->authenticator);
165
    start_table();
166
    row2(
167
        sprintf('%s <br><small>%s</small>',
168
            tra("To"),
169
            UNIQUE_USER_NAME
170
                ?tra('User names, one per line')
0 ignored issues
show
Coding Style introduced by
Expected 1 space before "?"; newline found
Loading history...
171
                :tra("User IDs or unique usernames, one per line")
0 ignored issues
show
Coding Style introduced by
Expected 1 space before ":"; newline found
Loading history...
172
        ),
173
        sprintf(
174
            '<textarea rows=2 class="form-control" name="to">%s</textarea>',
175
            $writeto
176
        ),
177
        null, '20%'
178
    );
179
    row2(
180
        tra("Subject"),
181
            "<input type=\"text\" class=\"form-control\" name=\"subject\" value=\"$subject\">",
182
        null, '20%'
183
    );
184
    row2_init(
185
        tra("Message")."<small>".bbcode_info().pm_rules()."</small>",
186
        '20%'
187
    );
188
    start_table();
189
    echo $bbcode_html;
190
    echo "<tr><td>\n";
191
    echo "<textarea name=\"content\" class=\"form-control\" rows=\"18\">$content</textarea>";
192
    echo "</td></tr>\n";
193
    end_table();
194
    echo "<tr><td></td><td><input class=\"btn btn-primary\" type=\"submit\" name=\"preview\" value=\"".tra("Preview")."\"> <input class=\"btn btn-success\" type=\"submit\" value=\"".tra("Send message")."\"></td></tr>\n";
195
    end_table();
196
197
    page_tail();
198
}
199
200
function send_pm_notification_email(
201
    $logged_in_user, $to_user, $subject, $content
0 ignored issues
show
Coding Style introduced by
Multi-line function declarations must define one parameter per line
Loading history...
202
) {
203
    $message  = "
204
You have received a new private message at ".PROJECT.".
205
206
From: $logged_in_user->name (ID $logged_in_user->id)
207
Subject: $subject
208
209
$content
210
211
--------------------------
212
To delete or respond to this message, visit:
213
".secure_url_base()."pm.php
214
215
To change email preferences, visit:
216
".secure_url_base()."edit_forum_preferences_form.php
217
Do not reply to this message.
218
" ;
0 ignored issues
show
Coding Style introduced by
Space found before semicolon; expected "";" but found "" ;"
Loading history...
219
    send_email($to_user, "[".PROJECT."] - private message", $message);
220
}
221
222
function pm_email_line($notify) {
223
    $pm = BoincPrivateMessage::lookup_id($notify->opaque);
224
    $from_user = BoincUser::lookup_id($pm->senderid);
225
    if (!$pm || !$from_user) return null;
226
    return "$from_user->name ".tra("sent you a private message; subject:")." '$pm->subject'";
227
}
228
229
function pm_web_line($notify) {
230
    $pm = BoincPrivateMessage::lookup_id($notify->opaque);
231
    $from_user = BoincUser::lookup_id($pm->senderid);
232
    if (!$pm || !$from_user) return null;
233
    return "<a href=pm.php>".tra("Private message%1 from %2, subject:" , "</a>", $from_user->name )." $pm->subject";
234
}
235
236
function pm_send_msg($from_user, $to_user, $subject, $content, $send_email) {
237
    $sql_subject = BoincDb::escape_string(sanitize_tags($subject));
238
    $sql_content = BoincDb::escape_string($content);
239
    $mid = BoincPrivateMessage::insert("(userid, senderid, date, subject, content) VALUES ($to_user->id, $from_user->id, UNIX_TIMESTAMP(), '$sql_subject', '$sql_content')");
240
    if (!$mid) {
241
        error_page(tra("Couldn't create message"));
242
    }
243
    // send email notification if needed
244
    //
245
    if ($send_email) {
246
        BoincForumPrefs::lookup($to_user);
247
        switch ($to_user->prefs->pm_notification) {
248
        case 0:
0 ignored issues
show
Coding Style introduced by
Empty CASE statements are not allowed
Loading history...
249
        case 2:
0 ignored issues
show
Coding Style introduced by
Empty CASE statements are not allowed
Loading history...
250
            break;
251
        case 1:
252
            send_pm_notification_email(
253
                $from_user, $to_user, $subject, $content
254
            );
255
            break;
256
        }
257
    }
258
259
    // create notification in any case
260
    //
261
    BoincNotify::insert("(userid, create_time, type, opaque) values ($to_user->id, ".time().", ".NOTIFY_PM.", $mid)");
262
}
263
264
function pm_count($userid, $duration) {
265
    $time = time() - $duration;
266
267
    // we don't want to include team messages in this count.
268
    // Kludge for excluding them based on subject.
269
    // Should add a flag to private_message to distinguish them.
270
    //
271
    return BoincPrivateMessage::count(
272
        "senderid=$userid AND date>$time AND subject not like 'Message from team%'"
273
    );
274
}
275
276
function check_pm_count($userid) {
277
    if ((pm_count($userid, 60) >= 2) || (pm_count($userid, 600) >= 5) ||
278
        (pm_count($userid, 3600) >= 15) || (pm_count($userid, 86400) >= 50)) {
279
        error_page(tra("You are not allowed to send privates messages so often. Please wait some time before sending more messages."));
280
    }
281
}
282
283
function pm_notification($user) {
284
    $output = "";
285
    $unread = BoincPrivateMessage::count("userid=$user->id AND opened=0");
286
287
    $output .= "<a href=\"pm.php?action=inbox\">".tra("Inbox")."</a>";
288
    if ($unread) {
289
        $output .= "<span class=\"inboxunread\"> ($unread ".tra("unread").")</span>\n";
290
    }
291
    $output .= " &middot; <a href=\"pm.php?action=new\">".tra("Write")."</a>\n";
292
    return $output;
293
}
294
295
function pm_email_remind($user) {
296
    if (!$user->prefs->pm_notification) {
297
        return "<br><small>" .
298
            tra(
299
                "For email notification, %1 edit community prefs %2",
300
                '<a href="edit_forum_preferences_form.php">', '</a>'
301
            ) .
302
            "</small>"
303
        ;
0 ignored issues
show
Coding Style introduced by
Space found before semicolon; expected ""</small>";" but found ""</small>"
;"
Loading history...
304
    }
305
    return "";
306
}
307
308
function pm_rss($notify, &$title, &$msg, &$url) {
309
    $pm = BoincPrivateMessage::lookup_id($notify->opaque);
310
    $from_user = BoincUser::lookup_id($pm->senderid);
311
    if (!$pm || !$from_user) {
312
        $msg = null;
313
        return;
314
    }
315
    $title = tra("Private message");
316
    $msg = "You have received a <a href=".secure_url_base()."pm.php>private message</a>.";
317
    $url = secure_url_base()."pm.php";
318
}
319
320
function pm_delete_user($user) {
321
    $mm = BoincPrivateMessage::enum("userid=$user->id or senderid=$user->id");
322
    foreach ($mm as $m) {
323
        $m->delete();
324
    }
325
}
326
327
$cvs_version_tracker[]="\$Id: pm.inc 14019 2007-11-01 23:04:39Z davea $";
328
?>
329