Passed
Pull Request — master (#5620)
by David
11:28 queued 01:24
created

pm_form()   C

Complexity

Conditions 13
Paths 84

Size

Total Lines 85
Code Lines 65

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 13
eloc 65
c 1
b 0
f 0
nc 84
nop 3
dl 0
loc 85
rs 6.0569

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 "<tr><td></td><td>
95
        <input class=\"btn btn-primary\" type=\"submit\" name=\"preview\" value=\"".tra("Preview")."\">
96
        <input class=\"btn btn-success\" type=\"submit\" value=\"".tra("Send message")."\">
97
        </td></tr>\n
98
    ";
99
    end_table();
100
    page_tail();
101
}
102
103
function pm_form($replyto, $userid, $error = null) {
104
    global $bbcode_html, $bbcode_js;
105
    global $g_logged_in_user;
106
    page_head(tra("Send private message"),'','','', $bbcode_js);
107
108
    if (post_str("preview", true) == tra("Preview")) {
109
        $content = post_str("content", true);
110
        panel(tra('Preview'),
111
            function() use($content) {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after USE keyword; found 0
Loading history...
112
                echo output_transform($content, null);
113
            }
114
        );
115
    }
116
117
    $subject = '';
118
    $content = '';
119
    if ($replyto) {
120
        $message = BoincPrivateMessage::lookup_id($replyto);
121
        if (!$message || $message->userid != $g_logged_in_user->id) {
122
            error_page(tra("no such message"));
123
        }
124
        $content = "[quote]".$message->content."[/quote]\n";
125
        $userid = $message->senderid;
126
        $user = BoincUser::lookup_id($userid);
127
        if (!$user) {
128
            error_page("Sender no longer exists");
129
        }
130
        $writeto = UNIQUE_USER_NAME?$user->name:$userid." (".$user->name.")";
131
        $subject = $message->subject;
132
        if (substr($subject, 0, 3) != "re:") {
133
            $subject = "re: ".$subject;
134
        }
135
    } elseif ($userid) {
136
        $user = BoincUser::lookup_id($userid);
137
        if (!$user) {
138
            error_page("Sender no longer exists");
139
        }
140
        $writeto = UNIQUE_USER_NAME?$user->name:$userid." (".$user->name.")";
141
    } else {
142
        $writeto = sanitize_tags(post_str("to", true));
143
        $subject = post_str("subject", true);
144
        $content = post_str("content", true);
145
    }
146
147
    $content = htmlspecialchars($content);
148
    $subject = htmlspecialchars($subject);
149
150
    if ($error != null) {
151
        echo "<p class=\"text-danger\">".$error."</p>\n";
152
    }
153
154
    echo "<form action=\"pm.php\" method=\"post\" name=\"post\" onsubmit=\"return checkForm(this)\">\n";
155
    echo "<input type=\"hidden\" name=\"action\" value=\"send\">\n";
156
    echo form_tokens($g_logged_in_user->authenticator);
157
    start_table();
158
    row2(
159
        sprintf('%s <br><small>%s</small>',
160
            tra("To"),
161
            UNIQUE_USER_NAME
162
                ?tra('User names, separated with commas')
0 ignored issues
show
Coding Style introduced by
Expected 1 space before "?"; newline found
Loading history...
163
                :tra("User IDs or unique usernames, separated with commas")
0 ignored issues
show
Coding Style introduced by
Expected 1 space before ":"; newline found
Loading history...
164
        ),
165
        "<input type=\"text\" class=\"form-control\" name=\"to\" value=\"$writeto\">",
166
        null, '20%'
167
    );
168
    row2(
169
        tra("Subject"),
170
            "<input type=\"text\" class=\"form-control\" name=\"subject\" value=\"$subject\">",
171
        null, '20%'
172
    );
173
    row2_init(
174
        tra("Message")."<small>".bbcode_info().pm_rules()."</small>",
175
        '20%'
176
    );
177
    start_table();
178
    echo $bbcode_html;
179
    echo "<tr><td>\n";
180
    echo "<textarea name=\"content\" class=\"form-control\" rows=\"18\">$content</textarea>";
181
    echo "</td></tr>\n";
182
    end_table();
183
    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";
184
    end_table();
185
186
    page_tail();
187
    exit();
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
188
}
189
190
function send_pm_notification_email(
191
    $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...
192
) {
193
    $message  = "
194
You have received a new private message at ".PROJECT.".
195
196
From: $logged_in_user->name (ID $logged_in_user->id)
197
Subject: $subject
198
199
$content
200
201
--------------------------
202
To delete or respond to this message, visit:
203
".secure_url_base()."pm.php
204
205
To change email preferences, visit:
206
".secure_url_base()."edit_forum_preferences_form.php
207
Do not reply to this message.
208
" ;
0 ignored issues
show
Coding Style introduced by
Space found before semicolon; expected "";" but found "" ;"
Loading history...
209
    send_email($to_user, "[".PROJECT."] - private message", $message);
210
}
211
212
function pm_email_line($notify) {
213
    $pm = BoincPrivateMessage::lookup_id($notify->opaque);
214
    $from_user = BoincUser::lookup_id($pm->senderid);
215
    if (!$pm || !$from_user) return null;
216
    return "$from_user->name ".tra("sent you a private message; subject:")." '$pm->subject'";
217
}
218
219
function pm_web_line($notify) {
220
    $pm = BoincPrivateMessage::lookup_id($notify->opaque);
221
    $from_user = BoincUser::lookup_id($pm->senderid);
222
    if (!$pm || !$from_user) return null;
223
    return "<a href=pm.php>".tra("Private message%1 from %2, subject:" , "</a>", $from_user->name )." $pm->subject";
224
}
225
226
function pm_send_msg($from_user, $to_user, $subject, $content, $send_email) {
227
    $sql_subject = BoincDb::escape_string(sanitize_tags($subject));
228
    $sql_content = BoincDb::escape_string($content);
229
    $mid = BoincPrivateMessage::insert("(userid, senderid, date, subject, content) VALUES ($to_user->id, $from_user->id, UNIX_TIMESTAMP(), '$sql_subject', '$sql_content')");
230
    if (!$mid) {
231
        error_page(tra("Couldn't create message"));
232
    }
233
    // send email notification if needed
234
    //
235
    if ($send_email) {
236
        BoincForumPrefs::lookup($to_user);
237
        switch ($to_user->prefs->pm_notification) {
238
        case 0:
0 ignored issues
show
Coding Style introduced by
Empty CASE statements are not allowed
Loading history...
239
        case 2:
0 ignored issues
show
Coding Style introduced by
Empty CASE statements are not allowed
Loading history...
240
            break;
241
        case 1:
242
            send_pm_notification_email(
243
                $from_user, $to_user, $subject, $content
244
            );
245
            break;
246
        }
247
    }
248
249
    // create notification in any case
250
    //
251
    BoincNotify::insert("(userid, create_time, type, opaque) values ($to_user->id, ".time().", ".NOTIFY_PM.", $mid)");
252
}
253
254
function pm_count($userid, $duration) {
255
    $time = time() - $duration;
256
257
    // we don't want to include team messages in this count.
258
    // Kludge for excluding them based on subject.
259
    // Should add a flag to private_message to distinguish them.
260
    //
261
    return BoincPrivateMessage::count(
262
        "senderid=$userid AND date>$time AND subject not like 'Message from team%'"
263
    );
264
}
265
266
function check_pm_count($userid) {
267
    if ((pm_count($userid, 60) >= 2) || (pm_count($userid, 600) >= 5) ||
268
        (pm_count($userid, 3600) >= 15) || (pm_count($userid, 86400) >= 50)) {
269
        error_page(tra("You are not allowed to send privates messages so often. Please wait some time before sending more messages."));
270
    }
271
}
272
273
function pm_notification($user) {
274
    $output = "";
275
    $unread = BoincPrivateMessage::count("userid=$user->id AND opened=0");
276
277
    $output .= "<a href=\"pm.php?action=inbox\">".tra("Inbox")."</a>";
278
    if ($unread) {
279
        $output .= "<span class=\"inboxunread\"> ($unread ".tra("unread").")</span>\n";
280
    }
281
    $output .= " &middot; <a href=\"pm.php?action=new\">".tra("Write")."</a>\n";
282
    return $output;
283
}
284
285
function pm_email_remind($user) {
286
    if (!$user->prefs->pm_notification) {
287
        return "<br><small>" .
288
            tra(
289
                "For email notification, %1 edit community prefs %2",
290
                '<a href="edit_forum_preferences_form.php">', '</a>'
291
            ) .
292
            "</small>"
293
        ;
0 ignored issues
show
Coding Style introduced by
Space found before semicolon; expected ""</small>";" but found ""</small>"
;"
Loading history...
294
    }
295
    return "";
296
}
297
298
function pm_rss($notify, &$title, &$msg, &$url) {
299
    $pm = BoincPrivateMessage::lookup_id($notify->opaque);
300
    $from_user = BoincUser::lookup_id($pm->senderid);
301
    if (!$pm || !$from_user) {
302
        $msg = null;
303
        return;
304
    }
305
    $title = tra("Private message");
306
    $msg = "You have received a <a href=".secure_url_base()."pm.php>private message</a>.";
307
    $url = secure_url_base()."pm.php";
308
}
309
310
function pm_delete_user($user) {
311
    $mm = BoincPrivateMessage::enum("userid=$user->id or senderid=$user->id");
312
    foreach ($mm as $m) {
313
        $m->delete();
314
    }
315
}
316
317
$cvs_version_tracker[]="\$Id: pm.inc 14019 2007-11-01 23:04:39Z davea $";
318
?>
319