functions.php ➔ create_digest() - Code Metrics - Inspection of "adds EDC to registration org options for gcconnex" - gctools-outilsgc/gcconnex - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — add_edc_org ( 892691 )

unknown
created 2020-10-27 18:23 UTC
functions.php ➔ create_digest() F

↳ Parent: Project
Complexity

Conditions	42
Paths	2268
Size

Total Lines
431
Duplication

Lines	186
Ratio	43.16 %
Importance

Changes
Metric	Value
cc	42
nc	2268
nop	5
dl	186
loc	431
rs	0
c	0
b	0
f	0
How to fix Long Method Complexity

<?php

/**
 * recursively search for the group guid
 *
 * @param integer 	$entity_guid_static
 * @param integer 	$entity_guid
 *
 */
function get_forum_in_group($entity_guid_static, $entity_guid) {
	$entity = get_entity($entity_guid);
	// (base) stop recursing when we reach group guid
	if ($entity instanceof ElggGroup)  
		return $entity_guid;
	else 
		return get_forum_in_group($entity_guid_static, $entity->getContainerGUID());
}


/**
 * @param integer 			$user_id 
 * @param string 			$name 
 * @param array <string> 	$values
 * @param string 			$label
 */
function create_checkboxes($user_id, $name, $values, $label, $id='chkboxID', $class='chkboxClass') {
	$user_option = elgg_get_plugin_user_setting($name, $user_id, 'cp_notifications');


	if (strcmp($name, 'cpn_set_digest_freq_daily') == 0) {
		$user_option_daily = elgg_get_plugin_user_setting('cpn_set_digest_freq_daily', $user_id, 'cp_notifications');
		$user_option_weekly = elgg_get_plugin_user_setting('cpn_set_digest_freq_weekly', $user_id, 'cp_notifications');

		if (!$user_option_daily && !$user_option_weekly) $user_option = 'set_digest_daily';
	}

	if (strcmp($name, 'cpn_set_digest_lang_en') == 0) {
		$user_option_en = elgg_get_plugin_user_setting('cpn_set_digest_lang_en', $user_id, 'cp_notifications');
		$user_option_fr = elgg_get_plugin_user_setting('cpn_set_digest_lang_fr', $user_id, 'cp_notifications');

		if (!$user_option_en && !$user_option_fr) $user_option = 'set_digest_en';
	}

	$is_checked = (strcmp($user_option, 'set_digest_no') == 0 || strcmp($user_option, 'set_notify_off') == 0 || !$user_option || strpos($name, 'cpn_group_') !== false) ? false : true;

	$digest_option = elgg_get_plugin_user_setting('cpn_set_digest', $user_id, 'cp_notifications');
	$disabled = (strcmp('set_digest_yes', $digest_option) == 0 && strpos($name, 'site') !== false) ? true : false;

	$chkbox = elgg_view('input/checkbox', array(
		'name' => 		"params[{$name}]",
		'value' => 		$values[0],
		'default' => 	$values[1],
		'label' => 		$label,
		'checked' => 	$is_checked,
		'id' =>			$id,
		'class' =>		$class,
		'disabled' => 	$disabled
	));

	return $chkbox;
}


/**
 * check if object is: public, logged in, in group (check if user is in group), in friend-circle (check if user is in friend-circle)
 * 
 * @param ElggObject $entity		the entity we will check permissions of
 * @param int $recipient_user_id	the user guid.. to check if user is author's circle or friend
 */
function cp_check_permissions($entity, $recipient_user_id = 0) {
	$access_id = $entity->access_id;
	if ($access_id == 2 || $access_id == 1) // public or logged-in access
		return true;

	if ($access_id == -2) { // author or author's friends
		return check_entity_relationship($recipient_user_id, 'friend', $entity->getOwnerGUID()); // returns object
	}

	// Note: non-group members cannot subscribe to a group...
	// check if user is in friend's circle
	if ($access_id > 2) {
		$user_id_list = get_members_of_access_collection($access_id, true); // returns list of id in collection
		if (in_array($recipient_user_id, $user_id_list))
			return true;
	}

	return false;
}



/**
 * We need to modify the headers so that emails can go out (header spoofing)
 *
 * @param string 	$event
 */
function cp_get_headers($event = '') { 	// $event will be null if nothing is passed into it (no default value set)

	$email_address = elgg_get_plugin_setting('cp_notifications_email_addr','cp_notifications');
	if (!$email_address || $email_address === '') $email_address = '[email protected]';
	$php_version = phpversion();

	$headers =  "From: GCconnex <{$email_address}> \r\n";
	$headers .= "Reply-To: GCconnex <{$email_address}> \r\n";
	$headers .= "Return-Path: GCconnex <{$email_address}> \r\n";
	$headers .= "X-Mailer: PHP/{$php_version} \r\n";
	$headers .= "MIME-Version: 1.0 \r\n";
	$headers .= "Content-type: text/html; charset=utf-8 \r\n";
   
	if ($event === 'event') {
		$mime_boundary = "----Meeting Booking----".MD5(TIME());
		$headers .= 'Content-Type: multipart/alternative; boundary='.$mime_boundary."\r\n";
		$headers .= "Content-class: urn:content-classes:calendarmessage\n";
	}

	return $headers;
}



/**
 * scans the text object for any @mentions
 * 
 * @param string 	$cp_object
 */
function cp_scan_mentions($cp_object) {
	$fields = array('title','description','value');
	foreach($fields as $field) {
		$content = $cp_object->$field;													// pull the information from the fields saved to object
		if (preg_match_all("/\@([A-Za-z1-9]*).?([A-Za-z1-9]*)/", $content, $matches)) { // find all the string that matches: @christine.yu
			$users_found = array();
			
			foreach ($matches[0] as $match) {

				//if (preg_match('/\s/',$match)) { 										// what if no space found? check for space
					$user_found = explode(' ',$match);
					$users_found[] = $user_found[0];

				//}
			}
			return $users_found;
		}
	}
	return false;
}


function isJson($string) {
  json_decode($string);
  return (json_last_error() == JSON_ERROR_NONE);
}


/**
 * assembles the digest then encodes the array into JSON to be saved to digest_notification table
 *
 * @param ElggUser 		$invoked_by
 * @param string 		$subtype
 * @param ElggEntity 	$entity
 * @param ElggUser 		$send_to
 * @param string 		$entity_url (default value empty)
 * @return Success 		true/false
 */
function create_digest($invoked_by, $subtype, $entity, $send_to, $entity_url = '') {

	if (elgg_is_active_plugin('wet4')) elgg_load_library('GCconnex_display_in_language');
	elgg_load_library('elgg:gc_notification:functions');

	$digest = get_entity($send_to->cpn_newsletter);
	$digest_collection = json_decode($digest->description,true);

	// default title value
	$content_title = $entity->title;

	if (!$entity->title && ($subtype !== 'single_zip_file_upload' && $subtype !== 'multi_file_upload')) $entity = get_entity($entity->guid);

	if ($entity instanceof ElggObject) {
		$content_url = (!$entity_url) ? $entity->getURL() : $entity_url;

		if (isJson($entity->title))
		{
			$content_title = json_decode($entity->title, true);

		} else {

			if ($entity->title2) 

				$content_title = array('en' => $entity->title, 'fr' => $entity->title2);

			else 
				$content_title = array('en' => $entity->title, 'fr' => $entity->title);
			
		}

		$content_array = array(
			'content_title' => $content_title,
			'content_url' => $content_url."?utm_source=notification_digest&utm_medium=email",
			'subtype' => $entity->getSubtype(),
			'content_author_name' => $invoked_by->name,
			'content_author_url' => $invoked_by->getURL()."?utm_source=notification_digest&utm_medium=email"
		);

	} else {

        $content_array = array(
            'content_title' => 'colleague requests',
            'content_url' => $entity,
            'subtype' => $subtype
        );

    }

	if ($subtype === "hjforumcategory" || $subtype === "hjforum") return true;


	switch ($subtype) {

		case 'single_zip_file_upload':
			$file_entity = get_entity($entity[0]);
			$container = $file_entity->getContainerEntity();
			$file_count = 0;

			$display_files = "<p><ol>";
			foreach ($entity as $file_num => $file) {
				$file_count++;
				$file_entity = get_entity($file);
				$display_files .= "<li><a href='{$file_entity->getURL()}?utm_source=notification_digest&utm_medium=email'>{$file_entity->title}</a></li>";
			}
			$display_files .= "</ol></p>";
			$content_array = array(
				'file_count'			=> $file_count,
				'content_title' 		=> $display_files,
				'subtype' 				=> 'file_upload',
				'content_author_name' 	=> $file_entity->getOwnerEntity()->name,
				'content_author_url' 	=> $file_entity->getOwnerEntity()->getURL()
			);

			if ($container instanceof ElggUser) {
				$entity_guid = $file_entity->getGUID();
				$user_guid = $send_to->getGUID();
				$entry_type = 'personal';
				$group_name = NULL;
				$action_type = 'new_post';
				$notification_entry = json_encode($content_array);
			} else {
				$entity_guid = $file_entity->getGUID();
				$user_guid = $send_to->getGUID();
				$entry_type = 'group';
				$group_name = $container->name;
				$action_type = 'new_post';
				$notification_entry = json_encode($content_array);
			}
			break;

		case 'multi_file_upload':

			$file_entity = get_entity($entity[0]);
			$container = $file_entity->getContainerEntity();
			$file_count = 0;

			$display_files = "<p><ol>";
			foreach ($entity as $file_num => $file) {
				$file_count++;
				$file_entity = get_entity($file);
				$display_files .= "<li><a href='{$file_entity->getURL()}?utm_source=notification_digest&utm_medium=email'>{$file_entity->title}</a></li>";
			}

			$display_files .= "</ol></p>";
			$content_array = array(
				'file_count'			=> $file_count,
				'content_title' 		=> $display_files,
				'subtype' 				=> 'file_upload',
				'content_author_name' 	=> $file_entity->getOwnerEntity()->name,
				'content_author_url' 	=> $file_entity->getOwnerEntity()->getURL()
			);

			if ($container instanceof ElggUser) {
				$entity_guid = $file_entity->getGUID();
				$user_guid = $send_to->getGUID();
				$entry_type = 'personal';
				$group_name = NULL;
				$action_type = 'new_post';
				$notification_entry = json_encode($content_array);
			} else {
				$entity_guid = $file_entity->getGUID();
				$user_guid = $send_to->getGUID();
				$entry_type = 'group';
				$group_name = $container->name;
				$action_type = 'new_post';
				$notification_entry = json_encode($content_array);
			}

			break;

		case 'thewire':
			$content_array = array(
				'content_description' => $entity->description,
				'content_url' => $content_url."?utm_source=notification_digest&utm_medium=email",
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
				'subtype' => $entity->getSubtype(),
				'content_author_name' => $invoked_by->name,
				'content_author_url' => $invoked_by->getURL(),
				'entity' => $entity
			);

			$entity_guid = $entity->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'new_post';
			$notification_entry = json_encode($content_array);
			break;

		case 'mission':

			$content_array = array(
				'content_title' => $entity->title,
				'content_author_name' => $entity->getOwnerEntity()->name,
				'content_url' => $entity->getURL()."?utm_source=notification_digest&utm_medium=email",
				'subtype' => $entity->job_type,
				'deadline' => $entity->deadline
			);

			$entity_guid = $entity->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'mission';
			$group_name = NULL;
			$action_type = 'new_post';
			$notification_entry = json_encode($content_array);
			break;

		case 'comment':
		case 'discussion_reply':


			if ($entity->getContainerEntity() instanceof ElggGroup) {

				// string that will contain the url and the (json) string name of group
				$group_html = json_encode(array($entity->getContainerEntity()->getURL(), $entity->getContainerEntity()->name));
				$entity_guid = $entity->guid;
				$user_guid = $send_to->getGUID();
				$entry_type = 'group';
				$group_name = $group_html;
				$action_type = 'response';
				$notification_entry = json_encode($content_array);

			} else { 

				$entity_guid = $entity->guid;
				$user_guid = $send_to->getGUID();
				$entry_type = 'personal';
				$group_name = NULL;
				$action_type = 'response';
				$notification_entry = json_encode($content_array);
			}
			break;

		case 'cp_friend_request':

			$entity_guid = $invoked_by->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'friend_request';
			$notification_entry = json_encode($content_array);

		 	break;

		case 'cp_friend_approve':

			$entity_guid = $invoked_by->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'friend_approved';
			$notification_entry = json_encode($content_array);
			break;

		case 'cp_hjtopic':
		case 'cp_hjpost':

			$group_html = json_encode(array(get_entity(get_forum_in_group($entity->guid, $entity->guid))->getURL(), get_entity(get_forum_in_group($entity->guid, $entity->guid))->name));

			if ($subtype === 'cp_hjtopic') {

				$entity_guid = $entity->guid;
				$user_guid = $send_to->getGUID();
				$entry_type = 'group';
				$group_name = $group_html;
				$action_type = 'forum_topic';
				$notification_entry = json_encode($content_array);

			} else {

				$content_array = array(
					'content_title' => $entity->getContainerEntity()->title,
					'content_url' => $content_url."?utm_source=notification_digest&utm_medium=email",
					'subtype' => $entity->getSubtype(),
					'content_author' => $entity->getOwnerEntity()->guid
				);

				$entity_guid = $entity->guid;
				$user_guid = $send_to->getGUID();
				$entry_type = 'group';
				$group_name = $group_html;
				$action_type = 'forum_reply';
				$notification_entry = json_encode($content_array);

			}
			break;


		case 'like_comment':
		case 'like_reply':
		case 'post_likes':

			if ($subtype === "like_comment" || $subtype === "like_reply") {
				$content_title = $entity->getContainerEntity()->title;
				$content_array = array(
					'content_title' => $content_title,
					'content_url' =>  $entity->getURL()."?utm_source=notification_digest&utm_medium=email",
					'subtype' => $entity->getSubtype(),
					'content_author_name' => $invoked_by->name,
					'content_author_url' => $invoked_by->getURL()
				);


			} elseif ($entity->getSubtype() === 'thewire') {

				$content_array = array(
					'content_title' => $entity->description,
					'content_url' =>  $entity->getURL()."?utm_source=notification_digest&utm_medium=email",
					'subtype' => $entity->getSubtype(),
					'content_author_name' => $invoked_by->name,
					'content_author_url' => $invoked_by->getURL()
				);

			} else {
				$entity_title = $entity->title;
				if ($entity->title == '')
					$entity_title = $entity->name;

				$content_array = array(
					'content_title' => $entity_title,
					'content_url' =>  $entity->getURL()."?utm_source=notification_digest&utm_medium=email",
					'subtype' => $entity->getSubtype(),
					'content_author_name' => $invoked_by->name,
					'content_author_url' => $invoked_by->getURL()
				);
			}

			$entity_guid = $entity->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'likes';
			$notification_entry = json_encode($content_array);
			break;


		case 'content_revision':

			$entity_guid = $entity->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'content_revision';
			$notification_entry = json_encode($content_array);
			break;

		case 'cp_wire_share':

			$content_title = $entity->title;
			if (!$entity->title) $content_title = $entity->description;

			$content_array = array(
				'content_title' => $content_title,
				'content_url' => $entity->getURL()."?utm_source=notification_digest&utm_medium=email",
				'subtype' => $entity->getSubtype(),
				'content_author_name' => $invoked_by->name,
				'content_author_url' => $invoked_by->getURL()
			);

			$entity_guid = $entity->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'cp_wire_share';
			$notification_entry = json_encode($content_array);			
			break;

		case 'cp_wire_image':

			$content_array = array(
				'content_description' => $entity->description,
				'content_url' => $content_url."?utm_source=notification_digest&utm_medium=email",
				'subtype' => $entity->getSubtype(),
				'content_author_name' => $invoked_by->name,
				'content_author_url' => $invoked_by->getURL(),
				'wire_image' => thewire_image_get_attachments($entity->guid),
			);

			$entity_guid = $entity->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'new_post';
			$notification_entry = json_encode($content_array);
			break;

		case 'cp_wire_mention':

			$content_array = array(
				'content_url' => $entity->getURL()."?utm_source=notification_digest&utm_medium=email",
				'subtype' => 'wire_mention',
				'content_author' => $invoked_by->name,
				'content_author_url' => $invoked_by->getURL(), 
			);

			$entity_guid = $entity->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'mention';
			$notification_entry = json_encode($content_array);

			break;

		case 'cp_mention':

			$content_array = array(
				'content_title' => $entity->getContainerEntity()->title,
				'content_url' => $content_url."?utm_source=notification_digest&utm_medium=email",
				'subtype' => $entity->getContainerEntity()->getSubtype(),
				'content_author' => $invoked_by->name,
				'content_author_url' => $invoked_by->getURL()
			);

			$entity_guid = $entity->guid;
			$user_guid = $send_to->getGUID();
			$entry_type = 'personal';
			$group_name = NULL;
			$action_type = 'mention';
			$notification_entry = json_encode($content_array);
			break;

		default:

			$entity = get_entity($entity->guid);

			if ($entity->getContainerEntity() instanceof ElggGroup) {
			
				$group_title = $entity->getContainerEntity()->name;
				$group_html = json_encode(array($entity->getContainerEntity()->getURL(), $group_title));

				$entity_guid = $entity->guid;
				$user_guid = $send_to->getGUID();
				$entry_type = 'group';
				$group_name = $group_html;//"<a href='{$entity->getContainerEntity()->getURL()}?utm_source=notification_digest&utm_medium=email'>{$group_title}</a>";
				$action_type = 'new_post';
				$notification_entry = json_encode($content_array);

			}
			else {
				$entity_guid = $entity->guid;
				$user_guid = $send_to->getGUID();
				$entry_type = 'personal';
				$group_name = NULL;
				$action_type = 'new_post';
				$notification_entry = json_encode($content_array);
			}

			break;
	}

	// this will fix up/sanitize strings that may contain quotes, or any other (reserved) special character
	$group_name = base64_encode($group_name);
	$notification_entry = base64_encode($notification_entry);

	/// check if record exists already, if not then proceed.
	$query = "SELECT 1 FROM notification_digest WHERE entity_guid = {$entity_guid} AND user_guid = {$user_guid} AND notification_entry = '{$notification_entry}'  LIMIT 1";
	$count_row = get_data($query);

	if (count($count_row) <= 0) {
		/// save, then transform the information to the database (notification_digest table)
		$user_guid = mysql_real_escape_string($user_guid);
		$entry_type = mysql_real_escape_string($entry_type);
		$action_type = mysql_real_escape_string($action_type);

		$query = "INSERT INTO notification_digest ( entity_guid, user_guid, entry_type, group_name, action_type, notification_entry ) VALUES ( {$entity_guid}, '{$user_guid}', '{$entry_type}', '{$group_name}', '{$action_type}', '{$notification_entry}' )";

		$insert_row = insert_data($query);
	}
	

	return true;
}



/**
 * renders the correct subtype for the notification to display
 * 
 * @param string 			$subtype_name
 * @param optional string 	$english
 */
function cp_translate_subtype($subtype_name, $english = true) {
	$label = '';
	switch($subtype_name) {
		case 'blog':
			$label = ($english) ? 'blog' : 'un blogue';
			break;
		case 'bookmarks':
			$label = ($english) ? 'bookmark' : 'un signet';
			break;
		case 'file':
			$label = ($english) ? 'file' : 'un fichier';
			break;
		case 'poll':
			$label = ($english) ? 'poll' : 'un sondage';
			break;
		case 'event_calendar':
			$label = ($english) ? 'event' : 'un événement';
			break;
		case 'album':
			$label = ($english) ? 'album' : 'un album';
			break;
		case 'groupforumtopic':
			$label = ($english) ? 'discussion' : 'une discussion';
			break;
		case 'image':
			$label = ($english) ? 'photo' : 'une image';
			break;
		case 'idea':
			$label = ($english) ? 'idea' : 'un idee';
			break;
		case 'page_top':
		case 'page':
				$label = ($english) ? 'page' : 'une page';
			break;
		case 'hjforumtopic':
			$label = ($english) ? 'forum topic' : 'un suget sur le forum';
			break;
		case 'hjforum':
			$label = ($english) ? 'forum' : 'un forum';
			break;
		case 'thewire':
			$label = ($english) ? 'wire' : 'un fil';
			break;
		case 'task_top':
			$label = ($english) ? 'task' : 'une tâche';
			break;
		case 'mission':
			$label = ($english) ? 'opportunity' : 'un oppourtunite';
			break;
		case 'answer':
			$label = ($english) ? 'answer' : 'réponse';
			break;
		case 'etherpad':
			$label = ($english) ? 'Doc' : 'Doc';
			break;
		default:
			$label = $subtype_name;
		break;
	}
	return $label;
}




/**
 * Helper function for notifications about new opportunities
 *
 * @param string 	$mission_type
 * @param string 	$role_type		offering or seeking
 *
 * @return int 		metastring id of the mission opt-in type
 */
function getMissionTypeMetastringid( $mission_type, $role_type ) {
	if ( $role_type == 'missions:offering' ){
		$typemap = array(
			'missions:micro_mission' => 'opt_in_missions',
			'missions:job_swap'	=> 'opt_in_swap',
			'missions:mentoring' => 'opt_in_mentored',
			'missions:job_shadowing' => 'opt_in_shadowed',
			'missions:assignment' => 'opt_in_assignSeek',
			'missions:deployment' => 'opt_in_deploySeek',
			'missions:job_rotation'	=> 'opt_in_rotation',
			'missions:skill_share' => 'opt_in_ssSeek',
			'missions:peer_coaching' => 'opt_in_pcSeek',
			'missions:job_share' => 'opt_in_jobshare',
			);
	}
	else {
		$typemap = array(
			'missions:micro-mission' => 'opt_in_missionCreate',
			'missions:job_swap' => 'opt_in_swap',
			'missions:mentoring' =>	'opt_in_mentoring',
			'missions:job_shadowing'	=>	'opt_in_shadowing',
			'missions:assignment'	=> 'opt_in_assignCreate',
			'missions:deployment'	=>	'opt_in_deployCreate',
			'missions:job_rotation'	=>	'opt_in_rotation',
			'missions:skill_share'	=>	'opt_in_ssCreate',
			'missions:peer_coaching'	=>	'opt_in_pcCreate',
			'missions:job_share'	=>	'opt_in_jobshare',
			);
	}

	return elgg_get_metastring_id( $typemap[$mission_type] );
}


/**
   * @param Array <string> $heading
   */
  function render_contents($content_array, $heading = '', $language_preference = 'en') {
    $author = $content_array['content_author_name'];

    // this is specifically for the Micro Missions portion due to extra field
    $subtype = elgg_echo($content_array['subtype']);
    $boolSubtype = ($language_preference === 'fr') ? false : true;
    $subtype = cp_translate_subtype($subtype, $boolSubtype);

    /// oppourtunities does not take into account for separate bilingual titles (no option for it)
    if (strpos($content_array['subtype'], 'missions') !== false )
    	$content_title = $content_array['content_title'];
    else {

    	/// otherwise, set to opposite language
    	$content_title = $content_array['content_title'][$language_preference];
    	if (empty($content_title)) {
    		$content_language = ($language_preference === 'en') ? 'fr' : 'en';
    		$content_title = $content_array['content_title'][$content_language];
    	}
    }

	if ($heading === 'new_post' && $subtype === 'file_upload') {

		$rendered_content = elgg_echo('cp_notifications:mail_body:subtype:file_upload', array($author, $content_array['file_count'], $content_array['content_title']), $language_preference );
    	$closing_date = elgg_echo('cp_newsletter:digest:opportunities:date', $language_preference).$content_array['deadline'];
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
      	$subtype = elgg_echo($content_array['subtype'], $language_preference);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

	} elseif ($content_array['deadline']) {

		$closing_date = elgg_echo('cp_newsletter:digest:opportunities:date', $language_preference).$content_array['deadline'];
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$subtype = elgg_echo($content_array['subtype'], $language_preference);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$url = "<a href='{$content_array['content_url']}'>{$content_title}</a>";
		$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:oppourtunity", array($author, $subtype, $url), $language_preference)." - ".$closing_date;


    } elseif ($heading === 'cp_wire_share') {


		$content_title = gc_explode_translation($content_array['content_title'],$language_preference);
		$url = "<a href='{$content_array['content_url']}'>{$content_title}</a>";
		if ($subtype === 'The Wire') $subtype = "<a href='{$content_array['content_url']}'>".elgg_echo('cp_notifications:mail_body:your_wire_post', $language_preference)."</a>";
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:content_share:wire", array($author, $subtype), $language_preference);

    	

	}elseif ($heading === 'cp_mention' || $heading === 'mention') {


		if ($content_array['subtype'] === 'wire_mention') {

			$content_title = elgg_echo("cp_notifications:subtype:name:thewire", $language_preference);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			$author = $content_array['content_author'];

			$url = "<a href='{$content_array['content_url']}'>{$content_title}</a>";
			$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:wire_mention", array($author, $url), $language_preference);

	    } else {

	   	  	$author = $content_array['content_author'];

			$content_title = gc_explode_translation($content_array['content_title'], $language_preference);
			$author = $content_array['content_author'];

			$url = "<a href='{$content_array['content_url']}'>{$content_title}</a>";
			$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:mention", array($author, cp_translate_subtype($content_array['subtype']),$url), $language_preference);

	  	}


	} elseif ($heading === 'forum_reply') {


		$author = get_entity($content_array['content_author']);


		$url = "<a href='{$content_array['content_url']}'>{$content_title}</a>";
		$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:hjforumpost", array($author->name, $url), $language_preference);


	} elseif (strcmp($heading, "content_revision") == 0) {

		$url = "<a href='{$content_array['content_url']}'>{$content_title}</a>";
		$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:{$heading}", array($author, $subtype, $url), $language_preference);


    } elseif ($content_array['subtype'] === 'thewire' && $heading !== 'likes') {

    	if($content_array['content_description'] && (is_array($content_array['wire_image']))){
			$content_array['content_description'] .= elgg_echo('cp_notification_wire_image', $language_preference);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    	}elseif($content_array['content_description'] == '' ){
			$content_array['content_description'] = elgg_echo('cp_notification_wire_image_only', $language_preference);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		}
// error_log(print_r($content_array,true));
// error_log('print array '.print_r($content_array['wire_image'],true));

//  if(is_array($content_array['wire_image'])){
//  	error_log('isset');
//  }else{error_log('not isset');}
		$url = " <a href='{$content_array['content_url']}'>".$content_array['content_description']."</a>";
		$wire_fil = elgg_echo('cp_notifications:subtype:name:thewire', $language_preference);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:{$content_array['subtype']}_digest", array($author,$wire_fil, $url), $language_preference);


    } elseif (strcmp($heading, "likes") === 0) {

		$url = "<a href='{$content_array['content_url']}'>{$content_title}</a>";
		$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:{$heading}", array($author, $url), $language_preference);


    } elseif ($heading === 'response') {

		$url = "<a href='{$content_array['content_url']}'>{$content_title}</a>";
		$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:{$heading}", array($author, $url), $language_preference);

    } else {


		// limit 35 characters
		$url = "<a href='{$content_array['content_url']}'>{$content_title}</a> {$closing_date}";
function someFunction() {
    $x = 5;
    echo $x;
}
		$boolSubtype = ($language_preference === 'fr') ? false : true;
		$subtype = cp_translate_subtype($content_array['subtype'], $boolSubtype);
		$n = "";
		$vowels = array('a','e','i','o','u');
		if (in_array($subtype{0}, $vowels)) $n = "n";
		$rendered_content = elgg_echo("cp_notifications:mail_body:subtype:any", array($author, "",$subtype, $url), $language_preference);
    }

    return $rendered_content;
  }



  /**
   * @param string  $heading
   *
   */
  function render_headers($heading, $user_name='', $language = "en", $number='') {

    $proper_heading = '';
    $number_items = ($number > 1) ? "plural" : "singular";

    switch ($heading) {
		case 'new_mission':	
		case 'new_post_in_group':
			$proper_heading = elgg_echo("cp_newsletter:heading:notify:new_post:group:{$number_items}", array(), $language);
			break;
		case 'personal':
		case 'mission':
		case 'group':
		case 'new_post':
		case 'cp_wire_share':
		case 'wire_share':
		case 'cp_wire_image':
		case 'likes':
		case 'friend_request':
		case 'content_revision':
			$proper_heading = elgg_echo("cp_newsletter:heading:notify:{$heading}:{$number_items}", array(), $language);
			break;

		case 'forum_topic':
		case 'forum_reply':
		case 'response':
			$proper_heading = elgg_echo("cp_newsletter:heading:notify:{$heading}:{$number_items}", array(), $language);
			break;
		case 'friend_approved':
			$proper_heading = elgg_echo("cp_newsletter:heading:notify:{$heading}:{$number_items}", array($user_name),$language);
			break;
		case 'cp_mention':
			$proper_heading = elgg_echo("cp_newsletter:heading:notify:{$heading}:{$number_items}", array(), $language);
			break;
		default:
			$proper_heading = $heading;
			if (isJSon($proper_heading)) {
				$group_heading = json_decode($heading, true);
				$proper_heading = $group_heading[1];
				if (isJson($proper_heading)) {
					$proper_heading = json_decode($proper_heading, true);
					$proper_heading = "<a href='{$group_heading[0]}'>$proper_heading[$language]</a>";
				}
			}
			
			break;
	}

    return $proper_heading;
}




/**
 *
 */
function information_icon($text, $url) {
	return "<span class='pull-right'><a title='{$text}'><span class='fa fa-info-circle icon-sel'><span class='wb-invisible'> </span></span></a></span>";
}

function has_group_subscriptions($group_guid, $user_guid) {
	$dbprefix = elgg_get_config('dbprefix');
	// normal objects
	$query = "SELECT r.guid_one, r.relationship, r.guid_two  FROM {$dbprefix}entity_relationships r LEFT JOIN {$dbprefix}entities e ON r.guid_two = e.guid LEFT JOIN (SELECT guid FROM {$dbprefix}groups_entity WHERE guid = {$group_guid}) g ON e.container_guid = g.guid WHERE r.relationship LIKE 'cp_subscribed_to_%' AND e.type = 'object' AND e.container_guid = {$group_guid} AND r.guid_one = {$user_guid} LIMIT 1";

	$subscriptions = get_data($query);
	if (sizeof($subscriptions) == 0) {

		// forums
		$query = "SELECT elgg_subtype.entity_guid, elgg_subtype.entity_subtype
		FROM {$dbprefix}entity_relationships r
		LEFT JOIN 
			(SELECT e.guid AS entity_guid, s.subtype AS entity_subtype FROM {$dbprefix}entities e, {$dbprefix}entity_subtypes s WHERE (s.subtype = 'hjforumtopic' OR s.subtype = 'hjforum') AND e.subtype = s.id) elgg_subtype ON elgg_subtype.entity_guid = r.guid_two 
		WHERE r.guid_one = {$user_guid} AND r.relationship LIKE 'cp_subscribed_to_%'";

		$forums = get_data($query);

		foreach ($forums as $forum) {
			if (!$forum->entity_guid) continue;
			$forum_entity = get_entity($forum->entity_guid);
			$forum_group_guid = get_forum_in_group($forum_entity->getGUID(), $forum_entity->getGUID());

			if ($forum_group_guid == $group_guid)
				return 1;

		}
		return 0;
	}

	return (sizeof($subscriptions) > 0);
}



/**
 * Helper functions for digest processing queue
 */
function enqueue( $user_guid ) {
	// add to queue
	try{
		$query = "INSERT INTO notification_digest_queue (user_guid) VALUES ({$user_guid})";
		$result = insert_data($query);
	} catch(Exception $e){
		// return 1 if there's an error
		return 1;
	}

	// return 1 if there's an error
	return $result === false;
}

/* go for something more along the lines of 'at most once' in here to ensure we don't get duplicate digests going out
 * to get closer to 'exactly once', the digest function can enqueue failed attempts
 * NOTE: this won't work so well with a split read-write db setup, will likely need to be done without using elgg db functions
 */
function dequeue() {
	$query_init = "SET @uid := NULL";	// mostly for termination
	$query_delete = "DELETE FROM notification_digest_queue WHERE user_guid = @uid := user_guid LIMIT 1";			// remove a row from queue and prepare the guid to be returned
	$query_select = "SELECT @uid as uid";

	get_data($query_init);
	delete_data($query_delete);
	$user_guid = get_data_row($query_select)->uid;
	
	return $user_guid;
}

function leader_election(){
	return enqueue(0) == 0;		// there is no user with guid = 0, but only one instance will successfuly insert this with user_guid being the primary key
}

function initialize_queue( $frequency ){
	$dbprefix = elgg_get_config('dbprefix');

	try{
		# get user guid list and insert them all into the queue  ... maybe get it to filter by $frequency too
		$query = "INSERT INTO notification_digest_queue (user_guid) SELECT entity_guid as user_guid FROM {$dbprefix}private_settings WHERE name = 'plugin:user_setting:cp_notifications:cpn_set_digest' AND value = 'set_digest_yes'";
		$result = insert_data($query);
	} catch (Exception $e) {/* let mysql take care of duplicate instert attempts */}
	
	sleep(60);		// can certainly be done in a better way, but this is simplest and is unlikely to cause duplicates or unsent digests.
	
	return 0;
}

function await_init(){
	#check / wait for the user_guid = 0 to be deleted, a maximum total wait time wouldn't be a bad idea either
	$query_select = "SELECT * FROM notification_digest_queue WHERE user_guid = 0";
	while ( get_data($query_select) ) {
		usleep(100);
	}
	return 0;
}

gctools-outilsgc / gcconnex

Push — add_edc_org ( 892691 )

functions.php ➔ create_digest() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like
