MessageManager::send_message()

Complexity

Conditions	56
Paths	> 20000

Size

Total Lines	328
Code Lines	204

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
    public static function send_message(
        $receiverUserId,
        $subject,
        $content,
        array $attachments = [],
        array $fileCommentList = [],
        $group_id = 0,
        $parent_id = 0,
        $editMessageId = 0,
        $topic_id = 0,
        $sender_id = 0,
        $directMessage = false,
        $forwardId = 0,
        $smsParameters = [],
        $checkCurrentAudioId = false,
        $forceTitleWhenSendingEmail = false,
        $status = 0,
        array $extraParams = []
    ) {
        $group_id = (int) $group_id;
        $receiverUserId = (int) $receiverUserId;
        $parent_id = (int) $parent_id;
        $editMessageId = (int) $editMessageId;
        $topic_id = (int) $topic_id;
        $status = empty($status) ? MESSAGE_STATUS_UNREAD : (int) $status;

        $sendEmail = true;
        if (!empty($receiverUserId)) {
            $receiverUserInfo = api_get_user_info($receiverUserId);
            if (empty($receiverUserInfo)) {
                return false;
            }

            // Disabling messages for inactive users.
            if (0 == $receiverUserInfo['active']) {
                return false;
            }

            // Disabling messages depending the pausetraining plugin.
            $allowPauseFormation =
                'true' === api_get_plugin_setting('pausetraining', 'tool_enable') &&
                'true' === api_get_plugin_setting('pausetraining', 'allow_users_to_edit_pause_formation');

            if ($allowPauseFormation) {
                $extraFieldValue = new ExtraFieldValue('user');
                $disableEmails = $extraFieldValue->get_values_by_handler_and_field_variable(
                    $receiverUserId,
                    'disable_emails'
                );

                // User doesn't want email notifications but chamilo inbox still available.
                if (!empty($disableEmails) &&
                    isset($disableEmails['value']) && 1 === (int) $disableEmails['value']
                ) {
                    $sendEmail = false;
                }

                if ($sendEmail) {
                    // Check if user pause his formation.
                    $pause = $extraFieldValue->get_values_by_handler_and_field_variable(
                        $receiverUserId,
                        'pause_formation'
                    );
                    if (!empty($pause) && isset($pause['value']) && 1 === (int) $pause['value']) {
                        $startDate = $extraFieldValue->get_values_by_handler_and_field_variable(
                            $receiverUserInfo['user_id'],
                            'start_pause_date'
                        );
                        $endDate = $extraFieldValue->get_values_by_handler_and_field_variable(
                            $receiverUserInfo['user_id'],
                            'end_pause_date'
                        );

                        if (
                            !empty($startDate) && isset($startDate['value']) && !empty($startDate['value']) &&
                            !empty($endDate) && isset($endDate['value']) && !empty($endDate['value'])
                        ) {
                            $now = time();
                            $start = api_strtotime($startDate['value']);
                            $end = api_strtotime($endDate['value']);

                            if ($now > $start && $now < $end) {
                                $sendEmail = false;
                            }
                        }
                    }
                }
            }
        }

        $user_sender_id = empty($sender_id) ? api_get_user_id() : (int) $sender_id;
        if (empty($user_sender_id)) {
            Display::addFlash(Display::return_message(get_lang('UserDoesNotExist'), 'warning'));

            return false;
        }

        $totalFileSize = 0;
        $attachmentList = [];
        if (is_array($attachments)) {
            $counter = 0;
            foreach ($attachments as $attachment) {
                $attachment['comment'] = isset($fileCommentList[$counter]) ? $fileCommentList[$counter] : '';
                $fileSize = isset($attachment['size']) ? $attachment['size'] : 0;
                if (is_array($fileSize)) {
                    foreach ($fileSize as $size) {
                        $totalFileSize += $size;
                    }
                } else {
                    $totalFileSize += $fileSize;
                }
                $attachmentList[] = $attachment;
                $counter++;
            }
        }

        if ($checkCurrentAudioId) {
            // Add the audio file as an attachment
            $audioId = Session::read('current_audio_id');
            if (!empty($audioId)) {
                $file = api_get_uploaded_file('audio_message', api_get_user_id(), $audioId);
                if (!empty($file)) {
                    $audioAttachment = [
                        'name' => basename($file),
                        'comment' => 'audio_message',
                        'size' => filesize($file),
                        'tmp_name' => $file,
                        'error' => 0,
                        'type' => DocumentManager::file_get_mime_type(basename($file)),
                    ];
                    // create attachment from audio message
                    $attachmentList[] = $audioAttachment;
                }
            }
        }

        // Validating fields
        if (empty($subject) && empty($group_id)) {
            Display::addFlash(
                Display::return_message(
                    get_lang('YouShouldWriteASubject'),
                    'warning'
                )
            );

            return false;
        } elseif ($totalFileSize > (int) api_get_setting('message_max_upload_filesize')) {
            $warning = sprintf(
                get_lang('FilesSizeExceedsX'),
                format_file_size(api_get_setting('message_max_upload_filesize'))
            );

            Display::addFlash(Display::return_message($warning, 'warning'));

            return false;
        }

        $now = api_get_utc_datetime();
        $table = Database::get_main_table(TABLE_MESSAGE);

        if (!empty($receiverUserId) || !empty($group_id)) {
            // message for user friend
            //@todo it's possible to edit a message? yes, only for groups
            if (!empty($editMessageId)) {
                $query = " UPDATE $table SET
                              update_date = '".$now."',
                              content = '".Database::escape_string($content)."'
                           WHERE id = '$editMessageId' ";
                Database::query($query);
                $messageId = $editMessageId;
            } else {
                $params = [
                    'user_sender_id' => $user_sender_id,
                    'user_receiver_id' => $receiverUserId,
                    'msg_status' => $status,
                    'send_date' => $now,
                    'title' => $subject,
                    'content' => $content,
                    'group_id' => $group_id,
                    'parent_id' => $parent_id,
                    'update_date' => $now,
                ];
                $messageId = Database::insert($table, $params);
            }

            // Forward also message attachments
            if (!empty($forwardId)) {
                $attachments = self::getAttachmentList($forwardId);
                foreach ($attachments as $attachment) {
                    if (!empty($attachment['file_source'])) {
                        $file = [
                            'name' => $attachment['filename'],
                            'tmp_name' => $attachment['file_source'],
                            'size' => $attachment['size'],
                            'error' => 0,
                            'comment' => $attachment['comment'],
                        ];

                        // Inject this array so files can be added when sending and email with the mailer
                        $attachmentList[] = $file;
                    }
                }
            }

            // Save attachment file for inbox messages
            if (is_array($attachmentList)) {
                foreach ($attachmentList as $attachment) {
                    if (0 == $attachment['error']) {
                        $comment = $attachment['comment'];
                        self::saveMessageAttachmentFile(
                            $attachment,
                            $comment,
                            $messageId,
                            null,
                            $receiverUserId,
                            $group_id
                        );
                    }
                }
            }

            // Save message in the outbox for user friend or group.
            if (empty($group_id) && MESSAGE_STATUS_UNREAD == $status) {
                $params = [
                    'user_sender_id' => $user_sender_id,
                    'user_receiver_id' => $receiverUserId,
                    'msg_status' => MESSAGE_STATUS_OUTBOX,
                    'send_date' => $now,
                    'title' => $subject,
                    'content' => $content,
                    'group_id' => $group_id,
                    'parent_id' => $parent_id,
                    'update_date' => $now,
                ];
                $outbox_last_id = Database::insert($table, $params);

                if ($extraParams) {
                    $extraParams['item_id'] = $outbox_last_id;
                    $extraFieldValues = new ExtraFieldValue('message');
                    $extraFieldValues->saveFieldValues($extraParams);
                }

                // save attachment file for outbox messages
                if (is_array($attachmentList)) {
                    foreach ($attachmentList as $attachment) {
                        if (0 == $attachment['error']) {
                            $comment = $attachment['comment'];
                            self::saveMessageAttachmentFile(
                                $attachment,
                                $comment,
                                $outbox_last_id,
                                $user_sender_id
                            );
                        }
                    }
                }
            }

            if ($sendEmail) {
                $notification = new Notification();
                $sender_info = api_get_user_info($user_sender_id);

                // add file attachment additional attributes
                $attachmentAddedByMail = [];
                foreach ($attachmentList as $attachment) {
                    $attachmentAddedByMail[] = [
                        'path' => $attachment['tmp_name'],
                        'filename' => $attachment['name'],
                    ];
                }

                if (empty($group_id)) {
                    $type = Notification::NOTIFICATION_TYPE_MESSAGE;
                    if ($directMessage) {
                        $type = Notification::NOTIFICATION_TYPE_DIRECT_MESSAGE;
                    }
                    $notification->saveNotification(
                        $messageId,
                        $type,
                        [$receiverUserId],
                        $subject,
                        $content,
                        $sender_info,
                        $attachmentAddedByMail,
                        $smsParameters,
                        $forceTitleWhenSendingEmail
                    );
                } else {
                    $usergroup = new UserGroup();
                    $group_info = $usergroup->get($group_id);
                    $group_info['topic_id'] = $topic_id;
                    $group_info['msg_id'] = $messageId;

                    $user_list = $usergroup->get_users_by_group(
                        $group_id,
                        false,
                        [],
                        0,
                        1000
                    );

                    // Adding more sense to the message group
                    $subject = sprintf(get_lang('ThereIsANewMessageInTheGroupX'), $group_info['name']);
                    $new_user_list = [];
                    foreach ($user_list as $user_data) {
                        $new_user_list[] = $user_data['id'];
                    }
                    $group_info = [
                        'group_info' => $group_info,
                        'user_info' => $sender_info,
                    ];
                    $notification->saveNotification(
                        $messageId,
                        Notification::NOTIFICATION_TYPE_GROUP,
                        $new_user_list,
                        $subject,
                        $content,
                        $group_info,
                        $attachmentAddedByMail,
                        $smsParameters
                    );
                }
            }

            return $messageId;
        }

        return false;
    }