mod/cp_notifications/start.php ➔ cp_create_annotation_notification()

Complexity

Conditions	61
Paths	1635

Size

Total Lines

348

Duplication

Lines	109
Ratio	31.32 %

Importance

Changes

0

<?php
function cp_create_annotation_notification($event, $type, $object) {

	elgg_load_library('elgg:gc_notification:functions');
	$entity = get_entity($object->entity_guid);

	if ($entity->entity_minor_edit)	return;

	$dbprefix = elgg_get_config('dbprefix');
	$site = elgg_get_site_entity();
	$object_subtype = $object->getSubtype();
	$liked_content = get_entity($object->entity_guid);
	$type_of_like = $liked_content->getSubtype();
	if (!$type_of_like) $type_of_like = $liked_content->getType();

	$action_type = "content_revision";
	$author = $liked_by;

The variable $liked_by seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

	/// EDITS TO BLOGS AND PAGES, THEY ARE CONSIDERED ANNOTATION DUE TO REVISIONS AND MULTIPLE COPIES OF SAME CONTENT
	if (strcmp($object_subtype, 'likes') != 0) {

		$content = get_entity($object->entity_guid);
		$get_error_info='if object subtype likes 0';
		// auto save -drafts or -published blogs, we don't send out notifications
		if (strcmp($object_subtype,'blog_auto_save') == 0 && (strcmp($entity->status,'draft') == 0 || strcmp($entity->status, 'published') == 0)){
			$get_error_info='draft/autosave';
			return;
		} 


		// if we are publishing, or revising blogs then send out notification
		if (strcmp($object_subtype,'blog_revision') == 0 && strcmp($entity->status,'published') == 0) {
			$current_user = get_user($entity->getOwnerGUID());
			$subject = elgg_echo('cp_notify:subject:edit_content',array('The blog',gc_explode_translation($entity->title,'en'), $current_user->username),'en') . ' | ' . elgg_echo('cp_notify:subject:edit_content:m',array('Le blogue',gc_explode_translation($entity->title,'fr'), $current_user->username),'fr');
			$subject = htmlspecialchars_decode($subject,ENT_QUOTES);

			add_entity_relationship($entity->getOwnerGUID(), 'cp_subscribed_to_email', $entity->getGUID());
			add_entity_relationship($entity->getOwnerGUID(), 'cp_subscribed_to_site_mail', $entity->getGUID());

			$message = array(
				'cp_content' => $entity,
				'cp_user' => $current_user->username,
				'cp_msg_type' => 'cp_content_edit',
				'cp_fr_entity' => 'Ce blogue',
				'cp_en_entity' => 'blog',
			);

			if($entity->getContainerEntity() instanceof ElggGroup){
				$author_id = $object->getOwnerGUID();
				$content_id = $entity->getContainerGUID();
			}else{
				$author_id = $current_user->guid;
			}

			$author = $current_user;
			$content_entity = $entity;
			$get_error_info = 'blog revision or published';

			$watchers = get_subscribers($dbprefix, $author_id, $content_id);

The variable $content_id does not seem to be defined for all execution paths leading up to this point.

			foreach ($watchers as $watcher) {
				$message['user_name'] = $watcher->username;

				$template = elgg_view('cp_notifications/email_template', $message);

				$recipient_user = get_user($watcher->guid);

				if (has_access_to_entity($entity, $recipient_user) && $entity->access_id != 0) {

$recipient_user is of type object<ElggEntity>, but the function expects a object<ElggUser>|null.

					if (strcmp(elgg_get_plugin_user_setting('cpn_set_digest', $watcher->guid,'cp_notifications'), 'set_digest_yes') == 0)
						create_digest($author, $action_type, $content_entity, get_entity($watcher->guid));

$author of type object<ElggEntity> is not a sub-type of object<ElggUser>. It seems like you assume a child class of the class ElggEntity to be always present.

get_entity($watcher->guid) of type object<ElggEntity> is not a sub-type of object<ElggUser>. It seems like you assume a child class of the class ElggEntity to be always present.

					else
						(elgg_is_active_plugin('phpmailer')) ? phpmailer_send($watcher->email, $watcher->name, $subject, $template, NULL, true) : mail($watcher->email, $subject, $template, cp_get_headers());
				
					if (check_entity_relationship($watcher->guid, 'cp_subscribed_to_site_mail', $entity->getContainerGUID()))
						messages_send($subject, $template, $watcher->guid, $site->guid, 0, true, false);
				}
			}
			return true;
		}


		// checks for condition if the content being modified is a page or task
		if (strcmp($object_subtype,'page') == 0 || strcmp($object_subtype,'page_top') == 0 || strcmp($object_subtype,'task') == 0 || strcmp($object_subtype,'task_top') == 0) {
			$current_user = get_user($object->owner_guid);
			$subject = elgg_echo('cp_notify:subject:edit_content',array('The page', gc_explode_translation($entity->title,'en'), $current_user->username),'en');
			$subject .= ' | '.elgg_echo('cp_notify:subject:edit_content:f',array('La page', gc_explode_translation($entity->title,'fr'), $current_user->username),'fr');

			$subject = htmlspecialchars_decode($subject,ENT_QUOTES);

			$message = array(
				'cp_content' => $entity,
				'cp_user' => $current_user->username,
				'cp_msg_type' => 'cp_content_edit',
				'cp_fr_entity' => 'Cette page',
				'cp_en_entity' => 'page',
			);

			$author = $current_user;
			$content_entity = $entity;
			$get_error_info = 'page, page top';			

			$watchers = get_subscribers($dbprefix, $current_user->guid, $entity->guid);

			foreach ($watchers as $watcher) {
				$message['user_name'] = $watcher->username;
				$template = elgg_view('cp_notifications/email_template', $message);
				$recipient_user = get_user($watcher->guid);

				if (has_access_to_entity($entity, $recipient_user) /*&& $object->access_id != 0*/) {

$recipient_user is of type object<ElggEntity>, but the function expects a object<ElggUser>|null.

					if (strcmp(elgg_get_plugin_user_setting('cpn_set_digest', $watcher->guid,'cp_notifications'),'set_digest_yes') == 0) {

						create_digest($author, $action_type, $content_entity, get_entity($watcher->guid));

$author of type object<ElggEntity> is not a sub-type of object<ElggUser>. It seems like you assume a child class of the class ElggEntity to be always present.

get_entity($watcher->guid) of type object<ElggEntity> is not a sub-type of object<ElggUser>. It seems like you assume a child class of the class ElggEntity to be always present.

					}
					else {

						(elgg_is_active_plugin('phpmailer')) ? phpmailer_send( $watcher->email, $watcher->name, $subject, $template, NULL, true ) : mail($watcher->email, $subject, $template, cp_get_headers());
					}


					if (check_entity_relationship($watcher->guid, 'cp_subscribed_to_site_mail', $entity->getContainerGUID())) {
						$site_template = elgg_view('cp_notifications/site_template', $message);
						messages_send($subject, $site_template, $watcher->guid, $site->guid, 0, true, false);
					}
				}
			}
			return true;
		}
		
	} else {

		/// LIKES TO COMMENTS AND DISCUSSION REPLIES
    	$content_entity = get_entity($object->entity_guid); 			// get the comment object
		$comment_author = get_user($content_entity->owner_guid); 		// get the user who made the comment
		$content = get_entity($content_entity->getContainerGUID());		// get the location of comment
		$content_title = $content->title; 									// get title of content
		$liked_by = get_user($object->owner_guid); 							// get user who liked comment

		$action_type = "post_likes";

		$to_recipients = array();
		$to_recipients_site = array();
		$get_error_info = '';

	    switch ($type_of_like) {
	    	case 'group':
	    		$group_name_en = htmlspecialchars(filter_tags(htmlspecialchars_decode(gc_explode_translation($content_entity->name, 'en'))));
	    		$group_name_fr = htmlspecialchars(filter_tags(htmlspecialchars_decode(gc_explode_translation($content_entity->name, 'fr'))));

	    		$subject = elgg_echo(elgg_echo('cp_notify:subject:likes_group', array($liked_by->name, $group_name_en), 'en'));
	    		$subject .= elgg_echo(elgg_echo('cp_notify:subject:likes_group', array($liked_by->name, $group_name_fr), 'fr'));

	    		$message = array(
	    			'cp_liked_by' => $liked_by->name,
	    			'cp_group' => $content_entity->name,
	    			'cp_group_link' => $content_entity->getURL(),
	    			'cp_msg_type' => 'cp_like_group'
	    		);

	    		$group_owner = $content_entity->getOwnerEntity();
	    		$action_type = 'like_group';

	    		if (strcmp(elgg_get_plugin_user_setting('cpn_likes_email', $group_owner->getGUID(),'cp_notifications'),'likes_email') == 0)
					$to_recipients[$group_owner->getGUID()] = $group_owner;
					$get_error_info = 'group';

    			if (strcmp(elgg_get_plugin_user_setting('cpn_likes_site', $group_owner->getGUID(),'cp_notifications'),'likes_site') == 0)
					$to_recipients_site[$group_owner->getGUID()] = $group_owner;
					$get_error_info = 'group';

	    		break;

	    	case 'comment':

	    		$content_title_en = gc_explode_translation($content_title, 'en');
	    		$content_title_fr = gc_explode_translation($content_title, 'fr');

	    		$subject = elgg_echo('cp_notify:subject:likes_comment', array($liked_by->name, $content_title_en),'en');
	    		$subject .= ' | '.elgg_echo('cp_notify:subject:likes_comment',array($liked_by->name, $content_title_fr),'fr');

	    		$message = array(
	    			'cp_liked_by' => $liked_by->name,
	    			'cp_comment_from' => $content_title,
	    			'content_url' => $content->getURL(),
					'cp_msg_type' => 'cp_likes_comments',
				);

	    		$author = $liked_by;
	    		$action_type = "like_comment";

	    		if (strcmp(elgg_get_plugin_user_setting('cpn_likes_email', $comment_author->getGUID(),'cp_notifications'),'likes_email') == 0)
					$to_recipients[$comment_author->getGUID()] = $comment_author;
					$get_error_info = 'comment';

    			if (strcmp(elgg_get_plugin_user_setting('cpn_likes_site', $comment_author->getGUID(),'cp_notifications'),'likes_site') == 0)
					$to_recipients_site[$comment_author->getGUID()] = $comment_author;
					$get_error_info = 'comment';
	    		break;

	    	case 'discussion_reply':

	    		$content_title_en = gc_explode_translation($content_title, 'en');
	    		$content_title_fr = gc_explode_translation($content_title, 'fr');

	    		$subject = elgg_echo('cp_notify:subject:likes_discussion',array($liked_by->name, $content_title_en),'en');
	    		$subject .= ' | '.elgg_echo('cp_notify:subject:likes_discussion',array($liked_by->name, $content_title_fr),'fr');

				$message = array(
					'cp_liked_by' => $liked_by->name,
					'cp_comment_from' => $content_title,
					'content_url' => $content->getURL(),
					'cp_msg_type' => 'cp_likes_topic_replies',
				);
				$author = $liked_by;
				$action_type = "like_reply";

	    		if (strcmp(elgg_get_plugin_user_setting('cpn_likes_email', $comment_author->getGUID(),'cp_notifications'),'likes_email') == 0)
					$to_recipients[$comment_author->getGUID()] = $comment_author;
					$get_error_info = 'discussion_reply';
    			if (strcmp(elgg_get_plugin_user_setting('cpn_likes_site', $comment_author->getGUID(),'cp_notifications'),'likes_site') == 0)
					$to_recipients_site[$comment_author->getGUID()] = $comment_author;
					$get_error_info = 'discussion_reply';
	    		break;


	    	default:
	    		$type_of_like = 'user_update';
		    	if ($liked_content instanceof ElggUser) {

					// cyu - there doesn't seem to be any differentiation between updated avatar and colleague connection
		    		$liked_by = get_user($object->owner_guid); // get user who liked comment


		    		$subject = elgg_echo('cp_notify:subject:likes_user_update',array($liked_by->name),'en') . ' | ' . elgg_echo('cp_notify:subject:likes_user_update',array($liked_by->name),'fr');
		    		$message = array(
						'cp_msg_type' => 'cp_likes_user_update',
						'cp_liked_by' => $liked_by->name
					);
					$to_recipients[$liked_content->guid] = $liked_content;
					$get_error_info = 'user_update_if_liked_content';


		    	} else {

		    		$type_of_like = 'content';
		    		$liked_by = get_user($object->owner_guid); // get user who liked content
		    		$content = get_entity($object->entity_guid);

		    		$content_entity = $content;
		    		$author = $liked_by;

		    		$content_title_en = gc_explode_translation($content->title, 'en');
		    		$content_title_fr = gc_explode_translation($content->title, 'fr');

		    		// cyu - patching issue #323 (liking wire post)
		    		if ($content->getSubtype() === 'thewire') {
		    			$subject = elgg_echo('cp_notify:subject:likes_wire',array($liked_by->name, $content_title_en),'en') . ' | ' . elgg_echo('cp_notify:subject:likes_wire',array($liked_by->name, $content_title_fr), 'fr');
		    			$content_subtype = 'thewire';

		    		} else {
		    			$subject = elgg_echo('cp_notify:subject:likes',array($liked_by->name, $content_title_en),'en') . ' | ' . elgg_echo('cp_notify:subject:likes',array($liked_by->name, $content_title_fr), 'fr');
		    			$content_subtype = '';
		    		}

		    		$message = array(
		    			'cp_subtype' => $content_subtype,
						'cp_msg_type' => 'cp_likes_type',
						'cp_liked_by' => $liked_by->name,
						'cp_comment_from' => $content->title,
						'cp_description' => $content->description,
						'cp_content_url' => $content->getURL(),
					);

		    		if (strcmp(elgg_get_plugin_user_setting('cpn_likes_email', $content->getOwnerGUID(),'cp_notifications'), 'likes_email') == 0)
						$to_recipients[$content->getOwnerGUID()] = $content->getOwnerEntity();
						$get_error_info = 'content';

	    			if (strcmp(elgg_get_plugin_user_setting('cpn_likes_site', $content->getOwnerGUID(),'cp_notifications'), 'likes_site') == 0)
						$to_recipients_site[$content->getOwnerGUID()] = $content->getOwnerEntity();
						$get_error_info = 'content';
		    	}
	    		break;

		} // end switch statement
	}

	$subject = htmlspecialchars_decode($subject,ENT_QUOTES);

The variable $subject does not seem to be defined for all execution paths leading up to this point.

	if (is_array($to_recipients)) {
		// send notification out via email
		foreach ($to_recipients as $to_recipient_id => $to_recipient) {

The variable $to_recipients does not seem to be defined for all execution paths leading up to this point.

		
			$message['user_name'] = get_user($to_recipient->guid)->username;

The variable $message does not seem to be defined for all execution paths leading up to this point.

			$recipient_user = get_user($to_recipient->guid);

			if($recipient_user->gcdeactivate)
				continue;

			if ($liked_by->guid == $entity->getOwnerGUID() && $to_recipient->guid == $liked_by->guid)

The variable $liked_by does not seem to be defined for all execution paths leading up to this point.

				continue;

			if ($object->access_id == 1 || $object->access_id == 2 || $content_entity->getType() === 'group' || $action_type === 'post_likes') {

				if (strcmp(elgg_get_plugin_user_setting('cpn_set_digest', $to_recipient->guid,'cp_notifications'),'set_digest_yes') == 0)
					create_digest($author, $action_type, $content_entity, $to_recipient);

The variable $content_entity does not seem to be defined for all execution paths leading up to this point.

				else {
					$template = elgg_view('cp_notifications/email_template', $message);

					if (elgg_is_active_plugin('phpmailer')) {

						phpmailer_send( $to_recipient->email, $to_recipient->name, $subject, $template, NULL, true );
					}
					else
						mail($to_recipient->email, $subject, $template, cp_get_headers());
				}
			}
		}
	}

	if (is_array($to_recipients_site)) {
		// send notification out via site
		foreach ($to_recipients_site as $to_recipient_id => $to_recipient) {

The variable $to_recipients_site does not seem to be defined for all execution paths leading up to this point.

			$site_template = elgg_view('cp_notifications/site_template', $message);
			$recipient_user = get_user($to_recipient->guid);

			if (($object->access_id == 1 || $object->access_id == 2 || $content_entity->getType() === 'group' || $action_type === 'post_likes')  && 
				(strcmp(elgg_get_plugin_user_setting('cpn_set_digest', $to_recipient->guid,'cp_notifications'),'set_digest_yes') !== 0)) {

				messages_send($subject, $site_template, $to_recipient->guid, $site->guid, 0, true, false);
			}

		}
	}

	// register the error, if either of the arrays are not populated
	if (!is_array($to_recipients) || !is_array($to_recipients_site)) {
		$error_message = "error: in cp_create_notification(), \$to_recipients or \$to_recipients_site is not array"."\r\n"."Owner_entity = ".($content->getOwnerEntity()?print_r($content->getOwnerEntity(),true) : 'N/A');
		if ($comment_author) {
			$error_message .= 'Comment author= '. print_r($comment_author, true);

The variable $comment_author does not seem to be defined for all execution paths leading up to this point.

		}
		if ($group_owner) {
			$error_message .= 'Group owner= ' . print_r($group_owner, true);

The variable $group_owner does not seem to be defined for all execution paths leading up to this point.

		}
		$error_message .= 'State: '.$get_error_info; //from which state the error is from
		notification_logging($error_message);
	}

} // end of function