frappe/py/webnotes/modules/export_module.py

# Copyright (c) 2012 Web Notes Technologies Pvt Ltd (http://erpnext.com)
# 
# MIT License (MIT)
# 
# Permission is hereby granted, free of charge, to any person obtaining a 
# copy of this software and associated documentation files (the "Software"), 
# to deal in the Software without restriction, including without limitation 
# the rights to use, copy, modify, merge, publish, distribute, sublicense, 
# and/or sell copies of the Software, and to permit persons to whom the 
# Software is furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in 
# all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
# CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# 

"""
	Export files to modules
"""

from webnotes.modules import scrub, get_module_path
def export_to_files(record_list=[], record_module=None, verbose=0):
	"""
		Export record_list to files. record_list is a list of lists ([doctype],[docname] )  ,
	"""
	import webnotes.model.doc
	module_doclist =[]
	if record_list:
		for record in record_list:
			doclist = [d.fields for d in webnotes.model.doc.get(record[0], record[1])]
			write_document_file(doclist, record_module)

def create_init_py(modules_path, dt, dn):
	"""
		Creates __init__.py in the module directory structure
	"""
	import os

	def create_if_not_exists(path):
		initpy = os.path.join(path, '__init__.py')
		if not os.path.exists(initpy):
			open(initpy, 'w').close()
	
	create_if_not_exists(os.path.join(modules_path))
	create_if_not_exists(os.path.join(modules_path, dt))
	create_if_not_exists(os.path.join(modules_path, dt, dn))
	
def create_folder(module, dt, dn):
	"""
		Creates directories for module and their __init__.py
	"""
	import webnotes, os
	
	# get module path by importing the module
	modules_path = get_module_path(module)
			
	code_type = dt in ['DocType', 'Page', 'Search Criteria']
	
	# create folder
	folder = os.path.join(modules_path, code_type and scrub(dt) or dt, code_type and scrub(dn) or dn)
	
	webnotes.create_folder(folder)
	
	# create init_py_files
	if code_type:
		create_init_py(modules_path, scrub(dt), scrub(dn))
	
	return folder

def get_module_name(doclist, record_module=None):
	"""
		Returns the module-name of a doclist
	"""
	# module name
	if doclist[0]['doctype'] == 'Module Def':
		module = doclist[0]['name']
	elif doclist[0]['doctype']=='Control Panel':
		module = 'Core'
	elif record_module:
		module = record_module
	else:
		module = doclist[0]['module']

	return module
	
def write_document_file(doclist, record_module=None):
	"""
		Write a doclist to file, can optionally specify module name
	"""
	import os
	from webnotes.model.utils import pprint_doclist

	module = get_module_name(doclist, record_module)

	# create the folder
	code_type = doclist[0]['doctype'] in ['DocType','Page','Search Criteria']
	
	# create folder
	folder = create_folder(module, doclist[0]['doctype'], doclist[0]['name'])
	
	# separate code files
	clear_code_fields(doclist, folder, code_type)
		
	# write the data file	
	fname = (code_type and scrub(doclist[0]['name'])) or doclist[0]['name']
	txtfile = open(os.path.join(folder, fname +'.txt'),'w+')
	txtfile.write(pprint_doclist(doclist))
	#dict_list = [pprint_dict(d) for d in doclist]	
	#txtfile.write('[\n' + ',\n'.join(dict_list) + '\n]')
	txtfile.close()

def clear_code_fields(doclist, folder, code_type):
	"""
		Removes code from the doc
	"""
	
	import os
	import webnotes
	# code will be in the parent only
	code_fields = webnotes.code_fields_dict.get(doclist[0]['doctype'], [])
	
	for code_field in code_fields:
		if doclist[0].get(code_field[0]):

			doclist[0][code_field[0]] = None