<commit_before><?php

/**
 * @file include/forums.php
 * @brief Functions related to forum functionality *
 */


/**
 * @brief Function to list all forums a user is connected with
 *
 * @param int $uid of the profile owner
 * @param boolean $showhidden
 *	Show frorums which are not hidden
 * @param boolean $lastitem
 *	Sort by lastitem
 * @param boolean $showprivate
 *	Show private groups
 *
 * @returns array
 *	'url'	=> forum url
 *	'name'	=> forum name
 *	'id'	=> number of the key from the array
 *	'micro' => contact photo in format micro
 */
function get_forumlist($uid, $showhidden = true, $lastitem, $showprivate = false) {

	$forumlist = array();

	$order = (($showhidden) ? '' : ' AND NOT `hidden` ');
	$order .= (($lastitem) ? ' ORDER BY `last-item` DESC ' : ' ORDER BY `name` ASC ');
	$select = '`forum` ';
	if ($showprivate) {
		$select = '(`forum` OR `prv`)';
	}

	$contacts = q("SELECT `contact`.`id`, `contact`.`url`, `contact`.`name`, `contact`.`micro` FROM `contact`
			WHERE `network`= 'dfrn' AND $select AND `uid` = %d
			AND NOT `blocked` AND NOT `hidden` AND NOT `pending` AND NOT `archive`
			AND `success_update` > `failure_update`
			$order ",
			intval($uid)
	);

	foreach($contacts as $contact) {
		$forumlist[] = array(
			'url'	=> $contact['url'],
			'name'	=> $contact['name'],
			'id'	=> $contact['id'],
			'micro' => $contact['micro'],
		);
	}
	return($forumlist);
}


/**
 * @brief Forumlist widget
 * 
 * Sidebar widget to show subcribed friendica forums. If activated
 * in the settings, it appears at the notwork page sidebar
 * 
 * @param App $a
 * @return string
 */
function widget_forumlist($a) {

	if(! intval(feature_enabled(local_user(),'forumlist_widget')))
		return;

	$o = '';

	//sort by last updated item
	$lastitem = true;

	$contacts = get_forumlist($a->user['uid'],true,$lastitem, true);
	$total = count($contacts);
	$visible_forums = 10;

	if(count($contacts)) {

		$id = 0;

		foreach($contacts as $contact) {

			$entry = array(
				'url' => $a->get_baseurl() . '/network?f=&cid=' . $contact['id'],
				'external_url' => $a->get_baseurl() . '/redir/' . $contact['id'],
				'name' => $contact['name'],
				'cid' => $contact['id'],
				'micro' => proxy_url($contact['micro'], false, PROXY_SIZE_MICRO),
				'id' => ++$id,
			);
			$entries[] = $entry;
		}

		$tpl = get_markup_template('widget_forumlist.tpl');

		$o .= replace_macros($tpl,array(
			'$title'	=> t('Forums'),
			'$forums'	=> $entries,
			'$link_desc'	=> t('External link to forum'),
			'$total'	=> $total,
			'$visible_forums' => $visible_forums,
			'$showmore'	=> t('show more'),
		));
	}

	return $o;
}

/**
 * @brief Format forumlist as contact block
 * 
 * This function is used to show the forumlist in
 * the advanced profile.
 * 
 * @param int $uid
 * @return string
 * 
 */
function forumlist_profile_advanced($uid) {

	$profile = intval(feature_enabled($uid,'forumlist_profile'));
	if(! $profile)
		return;

	$o = '';

	// place holder in case somebody wants configurability
	$show_total = 9999;

	//don't sort by last updated item
	$lastitem = false;

	$contacts = get_forumlist($uid,false,$lastitem,false);

	$total_shown = 0;

	foreach($contacts as $contact) {
		$forumlist .= micropro($contact,false,'forumlist-profile-advanced');
		$total_shown ++;
		if($total_shown == $show_total)
			break;
	}

	if(count($contacts) > 0)
		$o .= $forumlist;
		return $o;
}

/**
 * @brief count unread forum items
 *
 * Count unread items of connected forums and private groups
 * 
 * @return array
 *	id = contact id
 *	name = contact name
 *	count = counted unseen items
 * 
 */

function forums_count_unseen() {
	$r = q("SELECT `contact`.`id`, `contact`.`name`, COUNT(`item`.`unseen`) AS `count` FROM `item`
			INNER JOIN `contact` ON `item`.`contact-id` = `contact`.`id`
			WHERE `item`.`uid` = %d AND `item`.`visible` AND NOT `item`.`deleted`
			AND `contact`.`network`= 'dfrn' AND (`contact`.`forum` OR `contact`.`prv`)
			AND NOT `contact`.`blocked` AND NOT `contact`.`hidden`
			AND NOT `contact`.`pending` AND NOT `contact`.`archive`
			AND `contact`.`success_update` > `failure_update`
			GROUP BY `contact`.`id` ",
		intval(local_user())
	);

	return $r;
}
<commit_msg>forumlist: little doxygen polishing<commit_after><?php

/**
 * @file include/forums.php
 * @brief Functions related to forum functionality *
 */


/**
 * @brief Function to list all forums a user is connected with
 *
 * @param int $uid of the profile owner
 * @param boolean $showhidden
 *	Show frorums which are not hidden
 * @param boolean $lastitem
 *	Sort by lastitem
 * @param boolean $showprivate
 *	Show private groups
 *
 * @returns array
 *	'url'	=> forum url
 *	'name'	=> forum name
 *	'id'	=> number of the key from the array
 *	'micro' => contact photo in format micro
 */
function get_forumlist($uid, $showhidden = true, $lastitem, $showprivate = false) {

	$forumlist = array();

	$order = (($showhidden) ? '' : ' AND NOT `hidden` ');
	$order .= (($lastitem) ? ' ORDER BY `last-item` DESC ' : ' ORDER BY `name` ASC ');
	$select = '`forum` ';
	if ($showprivate) {
		$select = '(`forum` OR `prv`)';
	}

	$contacts = q("SELECT `contact`.`id`, `contact`.`url`, `contact`.`name`, `contact`.`micro` FROM `contact`
			WHERE `network`= 'dfrn' AND $select AND `uid` = %d
			AND NOT `blocked` AND NOT `hidden` AND NOT `pending` AND NOT `archive`
			AND `success_update` > `failure_update`
			$order ",
			intval($uid)
	);

	foreach($contacts as $contact) {
		$forumlist[] = array(
			'url'	=> $contact['url'],
			'name'	=> $contact['name'],
			'id'	=> $contact['id'],
			'micro' => $contact['micro'],
		);
	}
	return($forumlist);
}


/**
 * @brief Forumlist widget
 * 
 * Sidebar widget to show subcribed friendica forums. If activated
 * in the settings, it appears at the notwork page sidebar
 * 
 * @param App $a
 * @return string
 */
function widget_forumlist($a) {

	if(! intval(feature_enabled(local_user(),'forumlist_widget')))
		return;

	$o = '';

	//sort by last updated item
	$lastitem = true;

	$contacts = get_forumlist($a->user['uid'],true,$lastitem, true);
	$total = count($contacts);
	$visible_forums = 10;

	if(count($contacts)) {

		$id = 0;

		foreach($contacts as $contact) {

			$entry = array(
				'url' => $a->get_baseurl() . '/network?f=&cid=' . $contact['id'],
				'external_url' => $a->get_baseurl() . '/redir/' . $contact['id'],
				'name' => $contact['name'],
				'cid' => $contact['id'],
				'micro' => proxy_url($contact['micro'], false, PROXY_SIZE_MICRO),
				'id' => ++$id,
			);
			$entries[] = $entry;
		}

		$tpl = get_markup_template('widget_forumlist.tpl');

		$o .= replace_macros($tpl,array(
			'$title'	=> t('Forums'),
			'$forums'	=> $entries,
			'$link_desc'	=> t('External link to forum'),
			'$total'	=> $total,
			'$visible_forums' => $visible_forums,
			'$showmore'	=> t('show more'),
		));
	}

	return $o;
}

/**
 * @brief Format forumlist as contact block
 * 
 * This function is used to show the forumlist in
 * the advanced profile.
 * 
 * @param int $uid
 * @return string
 * 
 */
function forumlist_profile_advanced($uid) {

	$profile = intval(feature_enabled($uid,'forumlist_profile'));
	if(! $profile)
		return;

	$o = '';

	// place holder in case somebody wants configurability
	$show_total = 9999;

	//don't sort by last updated item
	$lastitem = false;

	$contacts = get_forumlist($uid,false,$lastitem,false);

	$total_shown = 0;

	foreach($contacts as $contact) {
		$forumlist .= micropro($contact,false,'forumlist-profile-advanced');
		$total_shown ++;
		if($total_shown == $show_total)
			break;
	}

	if(count($contacts) > 0)
		$o .= $forumlist;
		return $o;
}

/**
 * @brief count unread forum items
 *
 * Count unread items of connected forums and private groups
 * 
 * @return array
 *	'id' => contact id
 *	'name' => contact/forum name
 *	'count' => counted unseen forum items
 * 
 */

function forums_count_unseen() {
	$r = q("SELECT `contact`.`id`, `contact`.`name`, COUNT(`item`.`unseen`) AS `count` FROM `item`
			INNER JOIN `contact` ON `item`.`contact-id` = `contact`.`id`
			WHERE `item`.`uid` = %d AND `item`.`visible` AND NOT `item`.`deleted`
			AND `contact`.`network`= 'dfrn' AND (`contact`.`forum` OR `contact`.`prv`)
			AND NOT `contact`.`blocked` AND NOT `contact`.`hidden`
			AND NOT `contact`.`pending` AND NOT `contact`.`archive`
			AND `contact`.`success_update` > `failure_update`
			GROUP BY `contact`.`id` ",
		intval(local_user())
	);

	return $r;
}

{'fraction_non_alphanumeric': 0.1833155587154876, 'fraction_numerical': 0.002132954141485958, 'mean_word_length': 3.867358708189158, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 58, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7346874', 'n_tokens_mistral': 3283, 'n_tokens_neox': 2947, 'n_words': 788}