From d0ade828c05545e45ce129c05090fa795d0376c1 Mon Sep 17 00:00:00 2001
From: rabuzarus <>
Date: Sun, 24 Jan 2016 19:56:23 +0100
Subject: [PATCH] rework autocomplete: some cleanup and docu

---
 include/acl_selectors.php              | 45 ++++++++----------
 include/dir_fns.php                    | 18 ++++++--
 include/nav.php                        | 59 +++++++++++-------------
 view/global.css                        |  2 -
 view/templates/message-head.tpl        |  2 +-
 view/templates/nav_head.tpl            |  0
 view/theme/vier/breathe.css            |  2 +-
 view/theme/vier/narrow.css             |  2 +-
 view/theme/vier/plus.css               |  2 +-
 view/theme/vier/shadow.css             |  4 +-
 view/theme/vier/style.css              | 64 ++++++++++++++------------
 view/theme/vier/templates/nav.tpl      |  4 +-
 view/theme/vier/templates/nav_head.tpl |  6 +++
 13 files changed, 107 insertions(+), 103 deletions(-)
 create mode 100644 view/templates/nav_head.tpl
 create mode 100644 view/theme/vier/templates/nav_head.tpl

diff --git a/include/acl_selectors.php b/include/acl_selectors.php
index d78393aeee..46f737e4c2 100644
--- a/include/acl_selectors.php
+++ b/include/acl_selectors.php
@@ -1,13 +1,15 @@
 <?php
 
+/**
+ * @file include/acl_selectors.php
+ */
+
 require_once("include/contact_selectors.php");
 require_once("include/contact_widgets.php");
+require_once("include/dir_fns.php");
 require_once("include/features.php");
 require_once("mod/proxy.php");
 
-/**
- *
- */
 
 /**
  * @package acl_selectors
@@ -653,7 +655,12 @@ function acl_lookup(&$a, $out_type = 'json') {
 
 	killme();
 }
-
+/**
+ * @brief Searching for global contacts for autocompletion
+ * 
+ * @param App $a
+ * @return type
+ */
 function navbar_complete(&$a) {
 
 //	logger('navbar_complete');
@@ -662,41 +669,25 @@ function navbar_complete(&$a) {
 		return;
 	}
 
-	$local = get_config('system','poco_local_search');
-	$local = true;
+	// check if searching in the local global contact table is enabled
+	$localsearch = get_config('system','poco_local_search');
 
 	$search = $prefix.notags(trim($_REQUEST['search']));
+
+	// don't search if search term has less than 2 characters
 	if(! $search || mb_strlen($search) < 2)
 		return array();
 
-	$star = false;
-	$address = false;
-
 	if(substr($search,0,1) === '@')
 		$search = substr($search,1);
 
-	if(substr($search,0,1) === '*') {
-		$star = true;
-		$search = substr($search,1);
-	}
-
-	if(strpos($search,'@') !== false) {
-		$address = true;
-	}
-
-	if($local) {
-		require_once("include/dir_fns.php");
-		$x = dirsearch_autocomplete($search);
+	if($localsearch) {
+		$x = dirsearch_global_by_name($search);
 		return $x;
 	}
 
-	if(! $local) {
-		require_once("include/dir_fns.php");
-		$url = $directory['url'] . '/dirsearch';
-	
-
+	if(! $localsearch) {
 		$p = (($a->pager['page'] != 1) ? '&p=' . $a->pager['page'] : '');
-	
 
 		$x = z_fetch_url(get_server().'/lsearch?f=' . $p .  '&search=' . urlencode($search));
 		if($x['success']) {
diff --git a/include/dir_fns.php b/include/dir_fns.php
index a362732b7b..2e39e7ddbf 100644
--- a/include/dir_fns.php
+++ b/include/dir_fns.php
@@ -1,11 +1,20 @@
 <?php
 
+/**
+ * @file include/dir_fns.php
+ * @brief Functions for directory
+ */
 
-
-function dirsearch_autocomplete($search) {
+/**
+ * @brief Search global contact table by nick or name
+ *  * 
+ * @param string $search
+ * @return array
+ */
+function dirsearch_global_by_name($search) {
 
 	if($search) {
-
+		// check supported networks
 		if (get_config('system','diaspora_enabled'))
 			$diaspora = NETWORK_DIASPORA;
 		else
@@ -16,7 +25,8 @@ function dirsearch_autocomplete($search) {
 		else
 			$ostatus = NETWORK_DFRN;
 
-		$results = q("SELECT `contact`.`id` AS `cid`, `gcontact`.`url`, `gcontact`.`name`, `gcontact`.`nick`, `gcontact`.`photo`, `gcontact`.`network`, `gcontact`.`keywords`, `gcontact`.`addr`
+		$results = q("SELECT `contact`.`id` AS `cid`, `gcontact`.`url`, `gcontact`.`name`, `gcontact`.`nick`, `gcontact`.`photo`,
+						`gcontact`.`network`, `gcontact`.`keywords`, `gcontact`.`addr`
 					FROM `gcontact`
 					LEFT JOIN `contact` ON `contact`.`nurl` = `gcontact`.`nurl`
 						AND `contact`.`uid` = %d AND NOT `contact`.`blocked`
diff --git a/include/nav.php b/include/nav.php
index 0261ab7d66..a90e850fe0 100644
--- a/include/nav.php
+++ b/include/nav.php
@@ -2,7 +2,7 @@
 
 function nav(&$a) {
 
-	/**
+	/*
 	 *
 	 * Build page header and site navigation bars
 	 *
@@ -11,23 +11,17 @@ function nav(&$a) {
 	if(!(x($a->page,'nav')))
 		$a->page['nav'] = '';
 
-	$base = z_root();
-	/**
+	$a->page['htmlhead'] .= replace_macros(get_markup_template('nav_head.tpl'), array());
+
+	/*
 	 * Placeholder div for popup panel
 	 */
 
-	$a->page['htmlhead'] .= <<< EOT
-
-<script>$(document).ready(function() {
-		$("#search-text").search_autocomplete('$base/acl');
-});
-</script>
-EOT;
 	$a->page['nav'] .= '<div id="panel" style="display: none;"></div>' ;
 
 	$nav_info = nav_info($a);
 
-	/**
+	/*
 	 * Build the page
 	 */
 
@@ -37,12 +31,13 @@ EOT;
 		'$baseurl' => $a->get_baseurl(),
 		'$sitelocation' => $nav_info['sitelocation'],
 		'$nav' => $nav_info['nav'],
-		'$banner' =>  $nav_info['banner'],
+		'$banner' => $nav_info['banner'],
 		'$emptynotifications' => t('Nothing new here'),
 		'$userinfo' => $nav_info['userinfo'],
-		'$sel' => 	$a->nav_sel,
+		'$sel' =>  $a->nav_sel,
 		'$apps' => $a->apps,
-		'$clear_notifs' => t('Clear notifications')
+		'$clear_notifs' => t('Clear notifications'),
+		'$search_hint' => t('@name, !forum, #tags, content')
 	));
 
 	call_hooks('page_header', $a->page['nav']);
@@ -53,7 +48,7 @@ function nav_info(&$a) {
 
 	$ssl_state = ((local_user()) ? true : false);
 
-	/**
+	/*
 	 *
 	 * Our network is distributed, and as you visit friends some of the
 	 * sites look exactly the same - it isn't always easy to know where you are.
@@ -69,7 +64,7 @@ function nav_info(&$a) {
 	// nav links: array of array('href', 'text', 'extra css classes', 'title')
 	$nav = Array();
 
-	/**
+	/*
 	 * Display login or logout
 	 */
 
@@ -100,7 +95,7 @@ function nav_info(&$a) {
 	}
 
 
-	/**
+	/*
 	 * "Home" should also take you home from an authenticated remote profile connection
 	 */
 
@@ -151,7 +146,7 @@ function nav_info(&$a) {
 
 	$nav['about'] = Array('friendica', t('Information'), "", t('Information about this friendica instance'));
 
-	/**
+	/*
 	 *
 	 * The following nav links are only show to logged in users
 	 *
@@ -195,7 +190,7 @@ function nav_info(&$a) {
 		$nav['contacts'] = array('contacts', t('Contacts'),"", t('Manage/edit friends and contacts'));
 	}
 
-	/**
+	/*
 	 * Admin page
 	 */
 	 if (is_site_admin()){
@@ -206,7 +201,7 @@ function nav_info(&$a) {
 	 $nav['navigation'] = array('navigation/', t('Navigation'), "", t('Site map'));
 
 
-	/**
+	/*
 	 *
 	 * Provide a banner/logo/whatever
 	 *
@@ -229,26 +224,26 @@ function nav_info(&$a) {
 }
 
 
-/*
+/**
  * Set a menu item in navbar as selected
  *
  */
 function nav_set_selected($item){
 	$a = get_app();
-    $a->nav_sel = array(
+	$a->nav_sel = array(
 		'community' 	=> null,
-		'network' 		=> null,
-		'home'			=> null,
-		'profiles'		=> null,
+		'network' 	=> null,
+		'home'		=> null,
+		'profiles'	=> null,
 		'introductions' => null,
 		'notifications'	=> null,
-		'messages'		=> null,
-		'directory'	    => null,
-		'settings'		=> null,
-		'contacts'		=> null,
-		'manage'        => null,
-		'events'        => null,
-		'register'      => null,
+		'messages'	=> null,
+		'directory'	=> null,
+		'settings'	=> null,
+		'contacts'	=> null,
+		'manage'	=> null,
+		'events'	=> null,
+		'register'	=> null,
 	);
 	$a->nav_sel[$item] = 'selected';
 }
diff --git a/view/global.css b/view/global.css
index ff2810292c..7fa9947d30 100644
--- a/view/global.css
+++ b/view/global.css
@@ -184,7 +184,6 @@ key { display: inline; background-color: #eee; color: #666; padding:0.2em; font-
 .notify-unseen { background-color: #cceeFF; }
 
 /* autocomplete popup */
-
 ul.acpopup {
   list-style: none;
   float: left;
@@ -194,7 +193,6 @@ ul.acpopup {
 }
 nav .acpopup {
   width: 290px;
-  margin-left: -35px;
   max-height: 450px;
   max-width: 300px;
   overflow-y: auto;
diff --git a/view/templates/message-head.tpl b/view/templates/message-head.tpl
index 49f268c42b..3fabebc0d2 100644
--- a/view/templates/message-head.tpl
+++ b/view/templates/message-head.tpl
@@ -1,7 +1,7 @@
 
 <script>
 $(document).ready(function() {
-	$("#recip").name_autocomplete(baseurl + '/acl', '', false, function(data) {
+	$("#recip").name_autocomplete(baseurl + '/acl', 'm', false, function(data) {
 		$("#recip-complete").val(data.id);
 	});
 });
diff --git a/view/templates/nav_head.tpl b/view/templates/nav_head.tpl
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/view/theme/vier/breathe.css b/view/theme/vier/breathe.css
index 5a36de03e0..ec6d91a569 100644
--- a/view/theme/vier/breathe.css
+++ b/view/theme/vier/breathe.css
@@ -43,7 +43,7 @@ nav a {
   color: #737373;
 }
 
-nav #search-box #search-text {
+nav #nav-search-box #nav-search-text {
   border-radius: 5px;
 }
 
diff --git a/view/theme/vier/narrow.css b/view/theme/vier/narrow.css
index 09f0e2f12e..ae289af3ac 100644
--- a/view/theme/vier/narrow.css
+++ b/view/theme/vier/narrow.css
@@ -7,6 +7,6 @@ nav ul li .menu-popup {
   right: 0px;
 }
 
-nav #search-box #search-text {
+nav #nav-search-box #nav-search-text {
   width: 100px;
 }
diff --git a/view/theme/vier/plus.css b/view/theme/vier/plus.css
index 8e1865a869..a8cf4d2b22 100644
--- a/view/theme/vier/plus.css
+++ b/view/theme/vier/plus.css
@@ -159,7 +159,7 @@ section {
   top: 44px;
 }
 
-nav #search-box #search-text {
+nav #nav-search-box #nav-search-text {
   background-color: initial;
   border-style: solid;
   border-width: 1px;
diff --git a/view/theme/vier/shadow.css b/view/theme/vier/shadow.css
index 2f0bd9cbc0..918f880a80 100644
--- a/view/theme/vier/shadow.css
+++ b/view/theme/vier/shadow.css
@@ -24,7 +24,7 @@ nav .nav-notify {
   padding: 1px 3px;
   border-radius: 5px 5px 5px 5px;
 }
-// -----
+
 nav .nav-menu-icon .nav-notify {
   top: 0px;
 }
@@ -146,7 +146,7 @@ section {
   top: 44px;
 }
 
-nav #search-box #search-text {
+nav #nav-search-box #nav-search-text {
   background-color: initial;
   border-style: solid;
   border-width: 1px;
diff --git a/view/theme/vier/style.css b/view/theme/vier/style.css
index ddf3df1dee..49e41d0dc6 100644
--- a/view/theme/vier/style.css
+++ b/view/theme/vier/style.css
@@ -24,69 +24,69 @@ img {
 }
 
 #pending-update {
-        float:right;
-        color: #ffffff;
-        font-weight: bold;
-        background-color: #FF0000;
-        padding: 0em 0.3em;
+	float:right;
+	color: #ffffff;
+	font-weight: bold;
+	background-color: #FF0000;
+	padding: 0em 0.3em;
 }
 
 .admin.linklist {
-        border: 0px;
+	border: 0px;
 	padding: 0px;
 	list-style: none;
 	margin-top: 0px;
 }
 
 .admin.link {
-        list-style-position: inside;
-        font-size: 1em;
+	list-style-position: inside;
+	font-size: 1em;
 /*        padding-left: 5px;
-        margin: 5px; */
+	margin: 5px; */
 }
 
 #adminpage dl {
-        clear: left;
-        margin-bottom: 2px;
-        padding-bottom: 2px;
-        border-bottom: 1px solid black;
+	clear: left;
+	margin-bottom: 2px;
+	padding-bottom: 2px;
+	border-bottom: 1px solid black;
 }
 
 #adminpage dt {
-        width: 200px;
-        float: left;
-        font-weight: bold;
+	width: 200px;
+	float: left;
+	font-weight: bold;
 }
 
 #adminpage dd {
-        margin-left: 200px;
+	margin-left: 200px;
 }
 #adminpage h3 {
-        border-bottom: 1px solid #898989;
-        margin-bottom: 5px;
-        margin-top: 10px;
+	border-bottom: 1px solid #898989;
+	margin-bottom: 5px;
+	margin-top: 10px;
 }
 
 #adminpage .submit {
-        clear:left;
+	clear:left;
 }
 
 #adminpage #pluginslist {
-        margin: 0px; padding: 0px;
+	margin: 0px; padding: 0px;
 }
 
 #adminpage .plugin {
-        list-style: none;
-        display: block;
+	list-style: none;
+	display: block;
 	/* border: 1px solid #888888; */
-        padding: 1em;
-        margin-bottom: 5px;
-        clear: left;
+	padding: 1em;
+	margin-bottom: 5px;
+	clear: left;
 }
 
 #adminpage .toggleplugin {
-        float:left;
-        margin-right: 1em;
+	float:left;
+	margin-right: 1em;
 }
 
 #adminpage table {width:100%; border-bottom: 1p solid #000000; margin: 5px 0px;}
@@ -642,7 +642,7 @@ nav ul li .menu-popup {
   right: auto;
 }
 
-nav #search-box #search-text {
+nav #nav-search-box #nav-search-text {
   /*background-image:  url('icons/lupe.png');
   background-repeat:no-repeat; */
   padding-left:0px;
@@ -912,6 +912,10 @@ acpopup-mce {
   color: #2d2d2d;
   max-height: 150px;
 }
+nav .acpopup {
+  top: 31px !important;
+  margin-left: -23px
+}
 .acpopupitem {
   color: #2d2d2d;
   padding: 4px;
diff --git a/view/theme/vier/templates/nav.tpl b/view/theme/vier/templates/nav.tpl
index d2b2838b3e..281714e3ed 100644
--- a/view/theme/vier/templates/nav.tpl
+++ b/view/theme/vier/templates/nav.tpl
@@ -80,9 +80,9 @@
 		{{/if}}
 
 		{{if $nav.search}}
-			<li role="search" id="search-box">
+			<li role="search" id="nav-search-box">
 				<form method="get" action="{{$nav.search.0}}">
-					<input accesskey="s" id="search-text" class="nav-menu-search" type="text" value="" name="search">
+					<input accesskey="s" id="nav-search-text" class="nav-menu-search" type="text" value="" name="search" placeholder=" {{$search_hint}}">
 					<select name="search-option">
 						<option value="fulltext">{{$nav.searchoption.0}}</option>
 						<option value="tags">{{$nav.searchoption.1}}</option>
diff --git a/view/theme/vier/templates/nav_head.tpl b/view/theme/vier/templates/nav_head.tpl
new file mode 100644
index 0000000000..ff1b96fae8
--- /dev/null
+++ b/view/theme/vier/templates/nav_head.tpl
@@ -0,0 +1,6 @@
+
+<script>
+$(document).ready(function() {
+	$("#nav-search-text").search_autocomplete(baseurl + '/acl');
+});
+</script>