Merge lp:~tomdroid-dev/tomdroid/search-interface into lp:~tomdroid-maintainers/tomdroid/main

[Stefan Hammer]

Search ability for Tomdroid!

 * Created standard Android Search Interface, called by clicking on Search button or Search menu
 * Search Results are shown in a Results List, clicking on the List-items opens the note.
 * Search history is saved and presented as suggestions while typing.
 * Search history can be deleted in Preferences.
 * Search is a SingleTop Activity -> clicking on back button in Results List brings you direct to Tomdroid List View.
 * Clicking on search button in Results List opens another search

I suggest to also merge usability-improvements branch, because the ability of clicking the Actionbar Tomdroid-icon to go back to List-View is really helpful here.

[Olivier Bilodeau (plaxx)]

Started the review.

One minor thing I note is that you need to be more careful about consistency. For ex: in the new search strings there is search_hint (underscore separation), strNoResults (java-style object name) and SearchResultTitle (java-style class name). We should aim for only one notation style unless we have a pattern.

Really not a big problem, not enough to go back and fix it IMO but with new code/strings we should aim to avoid it.

[Olivier Bilodeau (plaxx)]

review: Approve

=== modified file 'AndroidManifest.xml'
--- AndroidManifest.xml	2011-06-21 06:07:28 +0000
+++ AndroidManifest.xml	2011-07-16 10:36:02 +0000
@@ -29,6 +29,9 @@
         		<category android:name="android.intent.category.BROWSABLE" />
         		<data android:scheme="tomdroid" android:host="sync"/>
         	</intent-filter>
+        	<!-- enable the search dialog to send searches to SearchableActivity -->
+        	<meta-data android:name="android.app.default_searchable"
+                   android:value=".ui.Search" />
         </activity>
     
 		<activity android:name=".ui.ViewNote">
@@ -40,6 +43,18 @@
 			</intent-filter>
 		</activity>
 		
+		<activity android:name=".ui.Search"
+		          android:launchMode="singleTop">
+			<intent-filter>
+				<action android:name="android.intent.action.SEARCH" />
+			</intent-filter>
+			<meta-data	android:name="android.app.searchable"
+						android:resource="@xml/searchable"/>
+		</activity>
+		<provider	android:name=".util.SearchSuggestionProvider"
+					android:authorities="org.tomdroid.util.SearchSuggestionProvider"
+        />
+		
 		<provider android:name="NoteProvider"
             android:authorities="org.tomdroid.notes"
         />

=== modified file 'res/layout/main.xml'
--- res/layout/main.xml	2011-06-21 05:50:40 +0000
+++ res/layout/main.xml	2011-07-16 10:36:02 +0000
@@ -37,8 +37,14 @@
               />
               
   	<TextView android:id="@+id/list_empty"
-              android:layout_width="wrap_content"
-              android:layout_height="wrap_content"
-              android:text="@string/strListEmptyNoNotes"
+			android:text="@string/strListEmptyNoNotes"
+			android:layout_width="fill_parent"
+			android:layout_height="fill_parent"
+			android:singleLine="false"
+            android:textSize="25dip"
+            android:textStyle="bold"
+        	android:ellipsize="marquee"
+			android:padding="30dip"
+            android:textColor="#FF555555"
               />
 </LinearLayout>
\ No newline at end of file

=== added file 'res/layout/search.xml'
--- res/layout/search.xml	1970-01-01 00:00:00 +0000
+++ res/layout/search.xml	2011-07-16 10:36:02 +0000
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 
+ Tomdroid
+ Tomboy on Android
+ http://www.launchpad.net/tomdroid
+
+ Copyright 2008, 2009 Olivier Bilodeau <[e-mail]>
+ 
+ This file is part of Tomdroid.
+ 
+ Tomdroid is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+ 
+ Tomdroid is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License
+ along with Tomdroid.  If not, see <http://www.gnu.org/licenses/>.
+-->
+<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+		android:layout_width="fill_parent"
+		android:layout_height="fill_parent"
+		android:orientation="vertical"
+    	>
+    	
+	<include android:id="@+id/actionbar" layout="@layout/actionbar" />
+    
+    <ListView android:id="@android:id/android:list"
+			android:layout_width="fill_parent"
+			android:layout_height="fill_parent"
+			android:divider="#FFCCCCCC"
+			android:dividerHeight="1px"
+              />
+              
+  	<TextView android:id="@+id/no_results"
+			android:text="@string/strNoResults"
+			android:layout_width="fill_parent"
+			android:layout_height="fill_parent"
+			android:singleLine="false"
+            android:textSize="25dip"
+            android:textStyle="bold"
+        	android:ellipsize="marquee"
+			android:padding="30dip"
+            android:textColor="#FF555555"
+              />
+</LinearLayout>
\ No newline at end of file

=== modified file 'res/menu/main.xml'
--- res/menu/main.xml	2011-06-18 12:59:36 +0000
+++ res/menu/main.xml	2011-07-16 10:36:02 +0000
@@ -24,13 +24,17 @@
 <menu xmlns:android="http://schemas.android.com/apk/res/android">
 
 	<item 
+			android:icon="@android:drawable/ic_menu_info_details"
 			android:title="@string/menuAbout"
-			android:id="@+id/menuAbout"
-			android:icon="@android:drawable/ic_menu_info_details"/>
-	
-	
+			android:id="@+id/menuAbout"/>
+			
 	<item 
 			android:icon="@android:drawable/ic_menu_preferences"
 			android:title="@string/menuPrefs"
 			android:id="@+id/menuPrefs"/>
+			
+	<item 
+			android:icon="@android:drawable/ic_menu_search"
+			android:title="@string/menuSearch"
+			android:id="@+id/menuSearch"/>
 </menu>

=== modified file 'res/values/strings.xml'
--- res/values/strings.xml	2011-01-15 22:25:39 +0000
+++ res/values/strings.xml	2011-07-16 10:36:02 +0000
@@ -89,6 +89,16 @@
     <string name="menuFilterNotebook">Filter</string>
     <string name="strListEmptyNoNotebooks">There are no notebooks in the database.</string>
     <string name="allNotebooksFilter">All notebooks</string>
+    
+    <!--  Search -->
+    <string name="search_hint">Search notes</string>
+    <string name="strNoResults">No notes found for \"%s\"</string>
+    <string name="menuSearch">Search</string>
+    <string name="SearchResultTitle">Search Results:</string>
+    <string name="clearSearchHistoryTitle">Clear search history</string>
+    <string name="clearSearchHistory">Remove all the searches you have performed</string>
+    <string name="deletedSearchHistory">Search history has been cleared.</string>
+    
 	
 	<!-- Date -->
     <string name="textModified">Modified: </string>

=== modified file 'res/xml/preferences.xml'
--- res/xml/preferences.xml	2010-10-17 20:19:18 +0000
+++ res/xml/preferences.xml	2011-07-16 10:36:02 +0000
@@ -12,7 +12,12 @@
 							android:title="@string/prefSyncServer"
 							android:positiveButtonText="@string/prefAuthenticate"
 							android:shouldDisableView="true"/>
-							
+	</PreferenceCategory>
+	<PreferenceCategory android:title="@string/menuSearch">
+		<Preference
+                android:title="@string/clearSearchHistoryTitle"
+                android:summary="@string/clearSearchHistory"
+                android:key="clearSearchHistory" />
 	</PreferenceCategory>
 	
 </PreferenceScreen>
\ No newline at end of file

=== added file 'res/xml/searchable.xml'
--- res/xml/searchable.xml	1970-01-01 00:00:00 +0000
+++ res/xml/searchable.xml	2011-07-16 10:36:02 +0000
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<searchable xmlns:android="http://schemas.android.com/apk/res/android"
+    android:label="@string/app_name"
+    android:hint="@string/search_hint"
+    android:searchSuggestAuthority="org.tomdroid.util.SearchSuggestionProvider"
+    android:searchSuggestSelection=" ?">
+</searchable>
\ No newline at end of file

=== modified file 'src/org/tomdroid/NoteManager.java'
--- src/org/tomdroid/NoteManager.java	2010-10-09 19:48:21 +0000
+++ src/org/tomdroid/NoteManager.java	2011-07-16 10:36:02 +0000
@@ -142,15 +142,37 @@
 	}
 	
 
-	public static ListAdapter getListAdapter(Activity activity) {
+	public static ListAdapter getListAdapter(Activity activity, String querys) {
+		
+		String where;
+		if (querys==null) {
+			where=null;
+		} else {
+			// sql statements to search notes
+			String[] query = querys.split(" ");
+			where="";
+			int count=0;
+			for (String string : query) {
+				if (count>0) where = where + " AND ";
+				where = where + "("+Note.TITLE+" LIKE '%"+string+"%' OR "+Note.NOTE_CONTENT+" LIKE '%"+string+"%')";
+				count++;
+			}	
+		}
 
-		Cursor notesCursor = getAllNotes(activity, false);
+		// get a cursor representing all notes from the NoteProvider
+		Uri notes = Tomdroid.CONTENT_URI;
+		Cursor notesCursor = activity.managedQuery(notes, LIST_PROJECTION, where, null, null);
 		
 		// set up an adapter binding the TITLE field of the cursor to the list item
-		String[] from = new String[] { Note.TITLE, Note.MODIFIED_DATE };
-		int[] to = new int[] { R.id.note_title, R.id.note_date };
+		String[] from = new String[] { Note.TITLE };
+		int[] to = new int[] { R.id.note_title };
 		return new NoteListCursorAdapter(activity, R.layout.main_list_item, notesCursor, from, to);
 	}
+	
+	public static ListAdapter getListAdapter(Activity activity) {
+		
+		return getListAdapter(activity, null);
+	}
 
 	// gets the titles of the notes present in the db, used in ViewNote.buildLinkifyPattern()
 	public static Cursor getTitles(Activity activity) {

=== modified file 'src/org/tomdroid/ui/PreferencesActivity.java'
--- src/org/tomdroid/ui/PreferencesActivity.java	2010-10-09 19:58:11 +0000
+++ src/org/tomdroid/ui/PreferencesActivity.java	2011-07-16 10:36:02 +0000
@@ -32,6 +32,7 @@
 import org.tomdroid.sync.SyncService;
 import org.tomdroid.util.FirstNote;
 import org.tomdroid.util.Preferences;
+import org.tomdroid.util.SearchSuggestionProvider;
 
 import android.app.AlertDialog;
 import android.app.ProgressDialog;
@@ -47,6 +48,8 @@
 import android.preference.Preference;
 import android.preference.PreferenceActivity;
 import android.preference.Preference.OnPreferenceChangeListener;
+import android.preference.Preference.OnPreferenceClickListener;
+import android.provider.SearchRecentSuggestions;
 import android.util.Log;
 import android.widget.Toast;
 
@@ -57,6 +60,7 @@
 	// TODO: put the various preferences in fields and figure out what to do on activity suspend/resume
 	private EditTextPreference syncServer = null;
 	private ListPreference syncService = null;
+	private Preference clearSearchHistory = null;
 	
 	@Override
 	protected void onCreate(Bundle savedInstanceState) {
@@ -67,6 +71,7 @@
 		// Fill the Preferences fields
 		syncServer = (EditTextPreference)findPreference(Preferences.Key.SYNC_SERVER.getName());
 		syncService = (ListPreference)findPreference(Preferences.Key.SYNC_SERVICE.getName());
+		clearSearchHistory = (Preference)findPreference(Preferences.Key.CLEAR_SEARCH_HISTORY.getName());
 		
 		// Set the default values if nothing exists
 		this.setDefaults();
@@ -111,6 +116,21 @@
 			
 		});
 		
+		//delete Search History
+		clearSearchHistory.setOnPreferenceClickListener(new OnPreferenceClickListener() {
+	        public boolean onPreferenceClick(Preference preference) {
+	            SearchRecentSuggestions suggestions = new SearchRecentSuggestions(PreferencesActivity.this,
+	                    SearchSuggestionProvider.AUTHORITY, SearchSuggestionProvider.MODE);
+	            suggestions.clearHistory();
+	            	
+	        	Toast.makeText(getBaseContext(),
+                        getString(R.string.deletedSearchHistory),
+                        Toast.LENGTH_LONG).show();
+	        	Log.d(TAG, "Deleted search history.");
+	        	
+	        	return true;
+	        }
+	    });
 	}
 	
 	private void authenticate(String serverUri) {
@@ -243,5 +263,4 @@
 		    resetLocalDatabase();
 		}
 	}
-
 }

=== added file 'src/org/tomdroid/ui/Search.java'
--- src/org/tomdroid/ui/Search.java	1970-01-01 00:00:00 +0000
+++ src/org/tomdroid/ui/Search.java	2011-07-16 10:36:02 +0000
@@ -0,0 +1,104 @@
+package org.tomdroid.ui;
+
+import org.tomdroid.Note;
+import org.tomdroid.NoteManager;
+import org.tomdroid.R;
+import org.tomdroid.sync.SyncManager;
+import org.tomdroid.util.SearchSuggestionProvider;
+
+import android.app.ListActivity;
+import android.app.SearchManager;
+import android.content.Intent;
+import android.database.Cursor;
+import android.graphics.Color;
+import android.net.Uri;
+import android.os.Bundle;
+import android.os.Handler;
+import android.provider.SearchRecentSuggestions;
+import android.util.Log;
+import android.view.View;
+import android.widget.ListAdapter;
+import android.widget.ListView;
+import android.widget.TextView;
+
+public class Search extends ListActivity {
+	
+	// Logging info
+	private static final String	TAG					= "Tomdroid Search";
+	// UI elements
+	private TextView title;
+	// UI to data model glue
+	private TextView			listEmptyView;	
+	// UI feedback handler
+	private Handler	syncMessageHandler	= new SyncMessageHandler(this);
+
+	private ListAdapter			adapter;
+
+	
+	@Override
+	public void onCreate(Bundle savedInstanceState) {
+	    super.onCreate(savedInstanceState);
+	    setContentView(R.layout.search);
+	    
+		title = (TextView) findViewById(R.id.title);
+		title.setTextColor(Color.DKGRAY);
+		title.setTextSize(18.0f);
+		title.setText((CharSequence) getString(R.string.SearchResultTitle));
+	    	    
+	    handleIntent(getIntent());
+	}
+
+	@Override
+	protected void onNewIntent(Intent intent) {
+	    setIntent(intent);
+	    handleIntent(intent);
+	}
+
+	private void handleIntent(Intent intent) {
+		//handles a search query
+	    if (Intent.ACTION_SEARCH.equals(intent.getAction())) {
+	      String query = intent.getStringExtra(SearchManager.QUERY);
+	      showResults(query);
+	    }
+	    
+	    //adds query to search history suggestions
+	    if (Intent.ACTION_SEARCH.equals(intent.getAction())) {
+	        String query = intent.getStringExtra(SearchManager.QUERY);
+	        SearchRecentSuggestions suggestions = new SearchRecentSuggestions(this,
+	                SearchSuggestionProvider.AUTHORITY, SearchSuggestionProvider.MODE);
+	        suggestions.saveRecentQuery(query, null);
+	    }
+	}
+
+	public void showResults(String query) {
+		if (Tomdroid.LOGGING_ENABLED) Log.d(TAG,"Start searching for: "+query);
+		
+		
+		// adapter that binds the ListView UI to the notes in the note manager
+		adapter = NoteManager.getListAdapter(this, query);
+		setListAdapter(adapter);
+		
+		// set the view shown when query not found
+		listEmptyView = (TextView) findViewById(R.id.no_results);
+		listEmptyView.setText(getString(R.string.strNoResults, new Object[] {query}));
+		getListView().setEmptyView(listEmptyView);
+	}
+	
+	@Override
+	protected void onListItemClick(ListView l, View v, int position, long id) {
+
+		Cursor item = (Cursor) adapter.getItem(position);
+		int noteId = item.getInt(item.getColumnIndexOrThrow(Note.ID));
+
+		Uri intentUri = Uri.parse(Tomdroid.CONTENT_URI + "/" + noteId);
+		Intent i = new Intent(Intent.ACTION_VIEW, intentUri, this, ViewNote.class);
+		startActivity(i);
+	}
+	
+	@Override
+	public void onResume(){
+		super.onResume();
+		SyncManager.setActivity(this);
+		SyncManager.setHandler(this.syncMessageHandler);
+	}
+}

=== modified file 'src/org/tomdroid/ui/Tomdroid.java'
--- src/org/tomdroid/ui/Tomdroid.java	2011-01-15 22:25:39 +0000
+++ src/org/tomdroid/ui/Tomdroid.java	2011-07-16 10:36:02 +0000
@@ -146,6 +146,10 @@
 			case R.id.menuPrefs:
 				startActivity(new Intent(this, PreferencesActivity.class));
 				return true;
+				
+			case R.id.menuSearch:
+				startSearch(null, false, null, false);
+				return true;
 		}
 
 		return super.onOptionsItemSelected(item);

=== modified file 'src/org/tomdroid/util/Preferences.java'
--- src/org/tomdroid/util/Preferences.java	2010-09-26 19:57:31 +0000
+++ src/org/tomdroid/util/Preferences.java	2011-07-16 10:36:02 +0000
@@ -33,6 +33,7 @@
 		SYNC_SERVER_ROOT_API ("sync_server_root_api", ""),
 		SYNC_SERVER_USER_API ("sync_server_user_api", ""),
 		SYNC_SERVER ("sync_server", "https://one.ubuntu.com/notes"),
+		CLEAR_SEARCH_HISTORY ("clearSearchHistory", ""),
 		ACCESS_TOKEN ("access_token", ""),
 		ACCESS_TOKEN_SECRET ("access_token_secret", ""),
 		REQUEST_TOKEN ("request_token", ""),

=== added file 'src/org/tomdroid/util/SearchSuggestionProvider.java'
--- src/org/tomdroid/util/SearchSuggestionProvider.java	1970-01-01 00:00:00 +0000
+++ src/org/tomdroid/util/SearchSuggestionProvider.java	2011-07-16 10:36:02 +0000
@@ -0,0 +1,12 @@
+package org.tomdroid.util;
+
+import android.content.SearchRecentSuggestionsProvider;
+
+public class SearchSuggestionProvider extends SearchRecentSuggestionsProvider {
+    public final static String AUTHORITY = "org.tomdroid.util.SearchSuggestionProvider";
+    public final static int MODE = DATABASE_MODE_QUERIES;
+
+    public SearchSuggestionProvider() {
+        setupSuggestions(AUTHORITY, MODE);
+    }
+}
\ No newline at end of file