blob: 0b4696c80345cf4714a93f21574145b364167a89 [file] [log] [blame]
Rushabh Mehta7231f292017-07-13 15:00:56 +05301import inspect
Chillar Anand915b3432021-09-02 16:44:59 +05302
Rushabh Mehta86a824c2016-04-15 16:44:44 +05303import frappe
Chillar Anand915b3432021-09-02 16:44:59 +05304
Rushabh Mehta7231f292017-07-13 15:00:56 +05305from erpnext.hooks import regional_overrides
Rushabh Mehta86a824c2016-04-15 16:44:44 +05306
Ankush Menatefec85d2021-11-26 16:29:21 +05307__version__ = '14.0.0-dev'
Anand Doshi227b2382016-06-09 16:29:12 +05308
Rushabh Mehta86a824c2016-04-15 16:44:44 +05309def get_default_company(user=None):
10 '''Get default company for user'''
11 from frappe.defaults import get_user_default_as_list
12
13 if not user:
14 user = frappe.session.user
15
16 companies = get_user_default_as_list(user, 'company')
17 if companies:
18 default_company = companies[0]
19 else:
20 default_company = frappe.db.get_single_value('Global Defaults', 'default_company')
21
22 return default_company
23
tundebabzya1091412017-05-19 07:12:45 +010024
Rushabh Mehta86a824c2016-04-15 16:44:44 +053025def get_default_currency():
26 '''Returns the currency of the default company'''
27 company = get_default_company()
28 if company:
Rushabh Mehta708e47a2018-08-08 16:37:31 +053029 return frappe.get_cached_value('Company', company, 'default_currency')
Rushabh Mehta66958302017-01-16 16:57:53 +053030
rohitwaghchaure2e8232e2017-08-10 11:32:59 +053031def get_default_cost_center(company):
32 '''Returns the default cost center of the company'''
33 if not company:
34 return None
35
36 if not frappe.flags.company_cost_center:
37 frappe.flags.company_cost_center = {}
38 if not company in frappe.flags.company_cost_center:
Rushabh Mehta708e47a2018-08-08 16:37:31 +053039 frappe.flags.company_cost_center[company] = frappe.get_cached_value('Company', company, 'cost_center')
rohitwaghchaure2e8232e2017-08-10 11:32:59 +053040 return frappe.flags.company_cost_center[company]
tundebabzya1091412017-05-19 07:12:45 +010041
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +053042def get_company_currency(company):
43 '''Returns the default company currency'''
44 if not frappe.flags.company_currency:
45 frappe.flags.company_currency = {}
46 if not company in frappe.flags.company_currency:
Nabin Hait2a774fa2018-08-09 11:50:34 +053047 frappe.flags.company_currency[company] = frappe.db.get_value('Company', company, 'default_currency', cache=True)
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +053048 return frappe.flags.company_currency[company]
49
Rohit Waghchaurea5f40942017-06-16 15:21:36 +053050def set_perpetual_inventory(enable=1, company=None):
51 if not company:
Rohit Waghchauree9ff1912017-06-19 12:54:59 +053052 company = "_Test Company" if frappe.flags.in_test else get_default_company()
tundebabzya1091412017-05-19 07:12:45 +010053
Rohit Waghchaurea5f40942017-06-16 15:21:36 +053054 company = frappe.get_doc("Company", company)
55 company.enable_perpetual_inventory = enable
56 company.save()
tundebabzya1091412017-05-19 07:12:45 +010057
Ankush Menatd7148ad2021-12-20 22:00:31 +053058def encode_company_abbr(name, company=None, abbr=None):
Rushabh Mehta66958302017-01-16 16:57:53 +053059 '''Returns name encoded with company abbreviation'''
Ankush Menatd7148ad2021-12-20 22:00:31 +053060 company_abbr = abbr or frappe.get_cached_value('Company', company, "abbr")
Rushabh Mehta66958302017-01-16 16:57:53 +053061 parts = name.rsplit(" - ", 1)
62
63 if parts[-1].lower() != company_abbr.lower():
64 parts.append(company_abbr)
65
tundebabzya1091412017-05-19 07:12:45 +010066 return " - ".join(parts)
67
Rohit Waghchauree9ff1912017-06-19 12:54:59 +053068def is_perpetual_inventory_enabled(company):
69 if not company:
70 company = "_Test Company" if frappe.flags.in_test else get_default_company()
tundebabzya1091412017-05-19 07:12:45 +010071
Rohit Waghchauree9ff1912017-06-19 12:54:59 +053072 if not hasattr(frappe.local, 'enable_perpetual_inventory'):
Rushabh Mehta777526e2017-06-20 12:14:32 +053073 frappe.local.enable_perpetual_inventory = {}
Rohit Waghchauree9ff1912017-06-19 12:54:59 +053074
Rushabh Mehta777526e2017-06-20 12:14:32 +053075 if not company in frappe.local.enable_perpetual_inventory:
Himanshu Mishra35b26272018-11-13 11:13:04 +053076 frappe.local.enable_perpetual_inventory[company] = frappe.get_cached_value('Company',
Rushabh Mehta708e47a2018-08-08 16:37:31 +053077 company, "enable_perpetual_inventory") or 0
Rohit Waghchauree9ff1912017-06-19 12:54:59 +053078
Rushabh Mehta777526e2017-06-20 12:14:32 +053079 return frappe.local.enable_perpetual_inventory[company]
Rushabh Mehta7231f292017-07-13 15:00:56 +053080
Rohit Waghchauref689d012018-05-17 23:29:37 +053081def get_default_finance_book(company=None):
82 if not company:
83 company = get_default_company()
84
85 if not hasattr(frappe.local, 'default_finance_book'):
86 frappe.local.default_finance_book = {}
87
88 if not company in frappe.local.default_finance_book:
Himanshu Mishra35b26272018-11-13 11:13:04 +053089 frappe.local.default_finance_book[company] = frappe.get_cached_value('Company',
Rushabh Mehta708e47a2018-08-08 16:37:31 +053090 company, "default_finance_book")
Rohit Waghchauref689d012018-05-17 23:29:37 +053091
92 return frappe.local.default_finance_book[company]
93
rohitwaghchauree8358f32018-05-16 11:02:26 +053094def get_party_account_type(party_type):
95 if not hasattr(frappe.local, 'party_account_types'):
96 frappe.local.party_account_types = {}
97
98 if not party_type in frappe.local.party_account_types:
99 frappe.local.party_account_types[party_type] = frappe.db.get_value("Party Type",
100 party_type, "account_type") or ''
101
102 return frappe.local.party_account_types[party_type]
103
Rushabh Mehta7231f292017-07-13 15:00:56 +0530104def get_region(company=None):
105 '''Return the default country based on flag, company or global settings
106
107 You can also set global company flag in `frappe.flags.company`
108 '''
109 if company or frappe.flags.company:
Himanshu Mishra35b26272018-11-13 11:13:04 +0530110 return frappe.get_cached_value('Company',
Deepesh Garg6a5ef262021-02-19 14:30:23 +0530111 company or frappe.flags.company, 'country')
Rushabh Mehta7231f292017-07-13 15:00:56 +0530112 elif frappe.flags.country:
113 return frappe.flags.country
114 else:
115 return frappe.get_system_settings('country')
116
Rushabh Mehta393becc2017-07-13 15:49:37 +0530117def allow_regional(fn):
118 '''Decorator to make a function regionally overridable
119
120 Example:
121 @erpnext.allow_regional
122 def myfunction():
123 pass'''
Rushabh Mehta7231f292017-07-13 15:00:56 +0530124 def caller(*args, **kwargs):
125 region = get_region()
126 fn_name = inspect.getmodule(fn).__name__ + '.' + fn.__name__
127 if region in regional_overrides and fn_name in regional_overrides[region]:
128 return frappe.get_attr(regional_overrides[region][fn_name])(*args, **kwargs)
129 else:
130 return fn(*args, **kwargs)
131
132 return caller
133
Shivam Mishra7e1cdf92020-11-09 14:01:11 +0530134def get_last_membership(member):
Vishalca614532017-09-11 15:13:16 +0530135 '''Returns last membership if exists'''
136 last_membership = frappe.get_all('Membership', 'name,to_date,membership_type',
Shivam Mishra7e1cdf92020-11-09 14:01:11 +0530137 dict(member=member, paid=1), order_by='to_date desc', limit=1)
Vishalca614532017-09-11 15:13:16 +0530138
Shivam Mishra7e1cdf92020-11-09 14:01:11 +0530139 if last_membership:
140 return last_membership[0]