Merge pull request #1938 from rmehta/help-db

[feature] added a new database _frappe_help containing all help files

frappe/commands/site.py

@@ -303,7 +303,7 @@ def uninstall(context, app, dry_run=False):
 @click.option('--archived-sites-path')
 def drop_site(site, root_login='root', root_password=None, archived_sites_path=None):
 	"Remove site from database and filesystem"
-	from frappe.installer import get_current_host, make_connection
+	from frappe.installer import get_root_connection
 	from frappe.model.db_schema import DbManager
 	from frappe.utils.backups import scheduled_backup
 
@@ -312,9 +312,9 @@ def drop_site(site, root_login='root', root_password=None, archived_sites_path=N
 	scheduled_backup(ignore_files=False, force=True)
 
 	db_name = frappe.local.conf.db_name
-	frappe.local.db = make_connection(root_login, root_password)
+	frappe.local.db = get_root_connection(root_login, root_password)
 	dbman = DbManager(frappe.local.db)
-	dbman.delete_user(db_name, get_current_host())
+	dbman.delete_user(db_name)
 	dbman.drop_database(db_name)
 
 	if not archived_sites_path:

frappe/installer.py

@@ -28,7 +28,7 @@ def install_db(root_login="root", root_password=None, db_name=None, source_sql=N
 		dbman.create_database(db_name)
 
 	else:
-		frappe.local.db = make_connection(root_login, root_password)
+		frappe.local.db = get_root_connection(root_login, root_password)
 		frappe.local.session = frappe._dict({'user':'Administrator'})
 		create_database_and_user(force, verbose)
 
@@ -44,25 +44,23 @@ def install_db(root_login="root", root_password=None, db_name=None, source_sql=N
 
 	frappe.flags.in_install_db = False
 
-def get_current_host():
-	return frappe.db.sql("select user()")[0][0].split('@')[1]
 
 def create_database_and_user(force, verbose):
 	db_name = frappe.local.conf.db_name
 	dbman = DbManager(frappe.local.db)
 	if force or (db_name not in dbman.get_database_list()):
-		dbman.delete_user(db_name, get_current_host())
+		dbman.delete_user(db_name)
 		dbman.drop_database(db_name)
 	else:
 		raise Exception("Database %s already exists" % (db_name,))
 
-	dbman.create_user(db_name, frappe.conf.db_password, get_current_host())
+	dbman.create_user(db_name, frappe.conf.db_password)
 	if verbose: print "Created user %s" % db_name
 
 	dbman.create_database(db_name)
 	if verbose: print "Created database %s" % db_name
 
-	dbman.grant_all_privileges(db_name, db_name, get_current_host())
+	dbman.grant_all_privileges(db_name, db_name)
 	dbman.flush_privileges()
 	if verbose: print "Granted privileges to user %s and database %s" % (db_name, db_name)
 
@@ -85,14 +83,17 @@ def import_db_from_sql(source_sql, verbose):
 	DbManager(frappe.local.db).restore_database(db_name, source_sql, db_name, frappe.conf.db_password)
 	if verbose: print "Imported from database %s" % source_sql
 
-def make_connection(root_login, root_password):
-	if root_login:
-		if not root_password:
-			root_password = frappe.conf.get("root_password") or None
+def get_root_connection(root_login='root', root_password=None):
+	if not frappe.local.flags.root_connection:
+		if root_login:
+			if not root_password:
+				root_password = frappe.conf.get("root_password") or None
 
-		if not root_password:
-			root_password = getpass.getpass("MySQL root password: ")
-	return frappe.database.Database(user=root_login, password=root_password)
+			if not root_password:
+				root_password = getpass.getpass("MySQL root password: ")
+		frappe.local.flags.root_connection = frappe.database.Database(user=root_login, password=root_password)
+
+	return frappe.local.flags.root_connection
 
 def install_app(name, verbose=False, set_as_patched=True):
 	frappe.clear_cache()
@@ -188,7 +189,7 @@ def remove_app(app_name, dry_run=False):
 
 				if not doctype.issingle:
 					drop_doctypes.append(doctype.name)
-					
+
 		# remove reports
 		for report in frappe.get_list("Report", filters={"module": module_name}):
 			print "removing {0}...".format(report.name)

frappe/model/db_schema.py

@@ -459,6 +459,8 @@ class DbManager:
  		if db:
  			self.db = db
 
+	def get_current_host(self):
+		return self.db.sql("select user()")[0][0].split('@')[1]
 
 	def get_variables(self,regex):
 		"""
@@ -480,8 +482,11 @@ class DbManager:
 
 		return [t[0] for t in self.db.sql("SHOW TABLES")]
 
-	def create_user(self, user, password, host):
+	def create_user(self, user, password, host=None):
 		#Create user if it doesn't exist.
+		if not host:
+			host = self.get_current_host()
+
 		try:
 			if password:
 				self.db.sql("CREATE USER '%s'@'%s' IDENTIFIED BY '%s';" % (user[:16], host, password))
@@ -490,8 +495,9 @@ class DbManager:
 		except Exception:
 			raise
 
-	def delete_user(self, target, host):
-	# delete user if exists
+	def delete_user(self, target, host=None):
+		if not host:
+			host = self.get_current_host()
 		try:
 			self.db.sql("DROP USER '%s'@'%s';" % (target, host))
 		except Exception, e:
@@ -504,15 +510,21 @@ class DbManager:
 		if target in self.get_database_list():
 			self.drop_database(target)
 
-		self.db.sql("CREATE DATABASE IF NOT EXISTS `%s` ;" % target)
+		self.db.sql("CREATE DATABASE `%s` ;" % target)
 
 	def drop_database(self,target):
 		self.db.sql("DROP DATABASE IF EXISTS `%s`;"%target)
 
-	def grant_all_privileges(self, target, user, host):
+	def grant_all_privileges(self, target, user, host=None):
+		if not host:
+			host = self.get_current_host()
+
 		self.db.sql("GRANT ALL PRIVILEGES ON `%s`.* TO '%s'@'%s';" % (target, user, host))
 
-	def grant_select_privilges(self, db, table, user, host):
+	def grant_select_privilges(self, db, table, user, host=None):
+		if not host:
+			host = self.get_current_host()
+
 		if table:
 			self.db.sql("GRANT SELECT ON %s.%s to '%s'@'%s';" % (db, table, user, host))
 		else:

frappe/utils/help.py

@@ -0,0 +1,66 @@
+# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
+# License: GNU General Public License v3. See license.txt
+
+from __future__ import unicode_literals
+
+import frappe
+
+from frappe.model.db_schema import DbManager
+from frappe.installer import get_root_connection
+from frappe.database import Database
+import os
+
+help_db_name = '_frappe_help'
+
+def sync():
+	# make table
+	help_db = HelpDatabase()
+	help_db.make_table()
+	help_db.sync_pages()
+
+@frappe.whitelist()
+def get_help(text):
+	return HelpDatabase().search(text)
+
+class HelpDatabase(object):
+	def __init__(self):
+		self.make_database()
+		self.connect()
+
+	def make_database(self):
+		dbman = DbManager(get_root_connection())
+
+		# make database
+		if not help_db_name in dbman.get_database_list():
+			dbman.create_user(help_db_name, help_db_name)
+			dbman.create_database(help_db_name)
+			dbman.grant_all_privileges(help_db_name, help_db_name)
+			dbman.flush_privileges()
+
+	def connect(self):
+		self.db = Database(user=help_db_name, password=help_db_name)
+
+	def make_table(self):
+		if not 'help' in self.db.get_tables():
+			self.db.sql('''create table help(path text, content text, fulltext(content))
+				COLLATE=utf8mb4_unicode_ci
+				ENGINE=MyISAM
+				CHARACTER SET=utf8mb4''')
+
+	def search(self, words):
+		return self.db.sql('select path, content from help where match(content) against (%s) limit 10', words)
+
+	def sync_pages(self):
+		self.db.sql('truncate help')
+		for app in os.listdir('../apps'):
+			docs_folder = '../apps/{app}/{app}/docs/user'.format(app=app)
+			if os.path.exists(docs_folder):
+				for basepath, folders, files in os.walk(docs_folder):
+					for fname in files:
+						if fname.rsplit('.', 1)[-1] in ('md', 'html'):
+							fpath = os.path.join(basepath, fname)
+							with open(fpath, 'r') as f:
+								#relpath = os.path.relpath(fpath, '../apps/{app}'.format(app=app))
+								self.db.sql('''insert into help(path, content)
+									values (%s, %s)''', (fpath, f.read()))
+