brotherton-erpnext/erpnext/accounts/report/general_ledger/general_ledger.py

# Copyright (c) 2013, Web Notes Technologies Pvt. Ltd. and Contributors
# License: GNU General Public License v3. See license.txt

from __future__ import unicode_literals
import frappe
from frappe.utils import cstr, flt
from frappe import _

def execute(filters=None):
	account_details = {}
	for acc in frappe.conn.sql("""select name, debit_or_credit, group_or_ledger 
		from tabAccount""", as_dict=1):
			account_details.setdefault(acc.name, acc)
	
	validate_filters(filters, account_details)
	
	columns = get_columns()
	
	res = get_result(filters, account_details)

	return columns, res
	
def validate_filters(filters, account_details):
	if filters.get("account") and filters.get("group_by_account") \
			and account_details[filters.account].group_or_ledger == "Ledger":
		frappe.throw(_("Can not filter based on Account, if grouped by Account"))
		
	if filters.get("voucher_no") and filters.get("group_by_voucher"):
		frappe.throw(_("Can not filter based on Voucher No, if grouped by Voucher"))
		
	if filters.from_date > filters.to_date:
		frappe.throw(_("From Date must be before To Date"))
	
def get_columns():
	return ["Posting Date:Date:100", "Account:Link/Account:200", "Debit:Float:100", 
		"Credit:Float:100", "Voucher Type::120", "Voucher No::160", "Link::20", 
		"Against Account::120", "Cost Center:Link/Cost Center:100", "Remarks::400"]
		
def get_result(filters, account_details):	
	gl_entries = get_gl_entries(filters)

	data = get_data_with_opening_closing(filters, account_details, gl_entries)
		
	result = get_result_as_list(data)

	return result
	
def get_gl_entries(filters):
	group_by_condition = "group by voucher_type, voucher_no, account" \
		if filters.get("group_by_voucher") else "group by name"
		
	gl_entries = frappe.conn.sql("""select posting_date, account, 
			sum(ifnull(debit, 0)) as debit, sum(ifnull(credit, 0)) as credit, 
			voucher_type, voucher_no, cost_center, remarks, is_opening, against 
		from `tabGL Entry`
		where company=%(company)s {conditions}
		{group_by_condition}
		order by posting_date, account"""\
		.format(conditions=get_conditions(filters), group_by_condition=group_by_condition), 
		filters, as_dict=1)
		
	return gl_entries
	
def get_conditions(filters):
	conditions = []
	if filters.get("account"):
		lft, rgt = frappe.conn.get_value("Account", filters["account"], ["lft", "rgt"])
		conditions.append("""account in (select name from tabAccount 
			where lft>=%s and rgt<=%s and docstatus<2)""" % (lft, rgt))
	else:
		conditions.append("posting_date between %(from_date)s and %(to_date)s")
		
	if filters.get("voucher_no"):
		conditions.append("voucher_no=%(voucher_no)s")
		
		
	from frappe.widgets.reportview import build_match_conditions
	match_conditions = build_match_conditions("GL Entry")
	if match_conditions: conditions.append(match_conditions)
	
	return "and {}".format(" and ".join(conditions)) if conditions else ""

def get_data_with_opening_closing(filters, account_details, gl_entries):
	data = []
	gle_map = initialize_gle_map(gl_entries)
	
	opening, total_debit, total_credit, gle_map = get_accountwise_gle(filters, gl_entries, gle_map)
	
	# Opening for filtered account
	if filters.get("account"):
		data += [get_balance_row("Opening", account_details[filters.account].debit_or_credit, 
			opening), {}]

	for acc, acc_dict in gle_map.items():
		if acc_dict.entries:
			# Opening for individual ledger, if grouped by account
			if filters.get("group_by_account"):
				data.append(get_balance_row("Opening", account_details[acc].debit_or_credit, 
					acc_dict.opening))

			data += acc_dict.entries
			
			# Totals and closing for individual ledger, if grouped by account
			if filters.get("group_by_account"):
				data += [{"account": "Totals", "debit": acc_dict.total_debit, 
					"credit": acc_dict.total_credit}, 
					get_balance_row("Closing (Opening + Totals)", 
						account_details[acc].debit_or_credit, (acc_dict.opening 
						+ acc_dict.total_debit - acc_dict.total_credit)), {}]
						
	# Total debit and credit between from and to date	
	if total_debit or total_credit:
		data.append({"account": "Totals", "debit": total_debit, "credit": total_credit})
	
	# Closing for filtered account
	if filters.get("account"):
		data.append(get_balance_row("Closing (Opening + Totals)", 
			account_details[filters.account].debit_or_credit, 
			(opening + total_debit - total_credit)))
	
	return data

def initialize_gle_map(gl_entries):
	gle_map = frappe._dict()
	for gle in gl_entries:
		gle_map.setdefault(gle.account, frappe._dict({
			"opening": 0,
			"entries": [],
			"total_debit": 0,
			"total_credit": 0,
			"closing": 0
		}))
	return gle_map

def get_accountwise_gle(filters, gl_entries, gle_map):
	opening, total_debit, total_credit = 0, 0, 0
	
	for gle in gl_entries:
		amount = flt(gle.debit) - flt(gle.credit)
		if filters.get("account") and (gle.posting_date < filters.from_date 
				or cstr(gle.is_opening) == "Yes"):
			gle_map[gle.account].opening += amount
			opening += amount
		elif gle.posting_date <= filters.to_date:
			gle_map[gle.account].entries.append(gle)
			gle_map[gle.account].total_debit += flt(gle.debit)
			gle_map[gle.account].total_credit += flt(gle.credit)
			
			total_debit += flt(gle.debit)
			total_credit += flt(gle.credit)
			
	return opening, total_debit, total_credit, gle_map

def get_balance_row(label, debit_or_credit, balance):
	return {
		"account": label,
		"debit": balance if debit_or_credit=="Debit" else 0,
		"credit": -1*balance if debit_or_credit=="Credit" else 0,
	}
	
def get_result_as_list(data):
	result = []
	for d in data:
		result.append([d.get("posting_date"), d.get("account"), d.get("debit"), 
			d.get("credit"), d.get("voucher_type"), d.get("voucher_no"), 
			get_voucher_link(d.get("voucher_type"), d.get("voucher_no")), 
			d.get("against"), d.get("cost_center"), d.get("remarks")])
	
	return result
	
def get_voucher_link(voucher_type, voucher_no):
	icon = ""
	if voucher_type and voucher_no:
		icon = """<a href="%s"><i class="icon icon-share" style="cursor: pointer;">
			</i></a>""" % ("/".join(["#Form", voucher_type, voucher_no]))
		
	return icon