Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
 
 
 
 
 
 

845 wiersze
25 KiB

  1. # Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
  2. # MIT License. See license.txt
  3. from __future__ import unicode_literals
  4. import frappe, sys
  5. from frappe import _
  6. from frappe.utils import (cint, flt, now, cstr, strip_html, getdate, get_datetime, to_timedelta,
  7. sanitize_html, sanitize_email)
  8. from frappe.model import default_fields
  9. from frappe.model.naming import set_new_name
  10. from frappe.model.utils.link_count import notify_link_count
  11. from frappe.modules import load_doctype_module
  12. from frappe.model import display_fieldtypes
  13. from frappe.model.db_schema import type_map, varchar_len
  14. from frappe.utils.password import get_decrypted_password, set_encrypted_password
  15. _classes = {}
  16. def get_controller(doctype):
  17. """Returns the **class** object of the given DocType.
  18. For `custom` type, returns `frappe.model.document.Document`.
  19. :param doctype: DocType name as string."""
  20. from frappe.model.document import Document
  21. global _classes
  22. if not doctype in _classes:
  23. module_name, custom = frappe.db.get_value("DocType", doctype, ["module", "custom"]) \
  24. or ["Core", False]
  25. if custom:
  26. _class = Document
  27. else:
  28. module = load_doctype_module(doctype, module_name)
  29. classname = doctype.replace(" ", "").replace("-", "")
  30. if hasattr(module, classname):
  31. _class = getattr(module, classname)
  32. if issubclass(_class, BaseDocument):
  33. _class = getattr(module, classname)
  34. else:
  35. raise ImportError, doctype
  36. else:
  37. raise ImportError, doctype
  38. _classes[doctype] = _class
  39. return _classes[doctype]
  40. class BaseDocument(object):
  41. ignore_in_getter = ("doctype", "_meta", "meta", "_table_fields", "_valid_columns")
  42. def __init__(self, d):
  43. self.update(d)
  44. self.dont_update_if_missing = []
  45. if hasattr(self, "__setup__"):
  46. self.__setup__()
  47. @property
  48. def meta(self):
  49. if not hasattr(self, "_meta"):
  50. self._meta = frappe.get_meta(self.doctype)
  51. return self._meta
  52. def update(self, d):
  53. if "doctype" in d:
  54. self.set("doctype", d.get("doctype"))
  55. # first set default field values of base document
  56. for key in default_fields:
  57. if key in d:
  58. self.set(key, d.get(key))
  59. for key, value in d.iteritems():
  60. self.set(key, value)
  61. return self
  62. def update_if_missing(self, d):
  63. if isinstance(d, BaseDocument):
  64. d = d.get_valid_dict()
  65. if "doctype" in d:
  66. self.set("doctype", d.get("doctype"))
  67. for key, value in d.iteritems():
  68. # dont_update_if_missing is a list of fieldnames, for which, you don't want to set default value
  69. if (self.get(key) is None) and (value is not None) and (key not in self.dont_update_if_missing):
  70. self.set(key, value)
  71. def get_db_value(self, key):
  72. return frappe.db.get_value(self.doctype, self.name, key)
  73. def get(self, key=None, filters=None, limit=None, default=None):
  74. if key:
  75. if isinstance(key, dict):
  76. return _filter(self.get_all_children(), key, limit=limit)
  77. if filters:
  78. if isinstance(filters, dict):
  79. value = _filter(self.__dict__.get(key, []), filters, limit=limit)
  80. else:
  81. default = filters
  82. filters = None
  83. value = self.__dict__.get(key, default)
  84. else:
  85. value = self.__dict__.get(key, default)
  86. if value is None and key not in self.ignore_in_getter \
  87. and key in (d.fieldname for d in self.meta.get_table_fields()):
  88. self.set(key, [])
  89. value = self.__dict__.get(key)
  90. return value
  91. else:
  92. return self.__dict__
  93. def getone(self, key, filters=None):
  94. return self.get(key, filters=filters, limit=1)[0]
  95. def set(self, key, value, as_value=False):
  96. if isinstance(value, list) and not as_value:
  97. self.__dict__[key] = []
  98. self.extend(key, value)
  99. else:
  100. self.__dict__[key] = value
  101. def delete_key(self, key):
  102. if key in self.__dict__:
  103. del self.__dict__[key]
  104. def append(self, key, value=None):
  105. if value==None:
  106. value={}
  107. if isinstance(value, (dict, BaseDocument)):
  108. if not self.__dict__.get(key):
  109. self.__dict__[key] = []
  110. value = self._init_child(value, key)
  111. self.__dict__[key].append(value)
  112. # reference parent document
  113. value.parent_doc = self
  114. return value
  115. else:
  116. raise ValueError, "Document attached to child table must be a dict or BaseDocument, not " + str(type(value))[1:-1]
  117. def extend(self, key, value):
  118. if isinstance(value, list):
  119. for v in value:
  120. self.append(key, v)
  121. else:
  122. raise ValueError
  123. def remove(self, doc):
  124. self.get(doc.parentfield).remove(doc)
  125. def _init_child(self, value, key):
  126. if not self.doctype:
  127. return value
  128. if not isinstance(value, BaseDocument):
  129. if "doctype" not in value:
  130. value["doctype"] = self.get_table_field_doctype(key)
  131. if not value["doctype"]:
  132. raise AttributeError, key
  133. value = get_controller(value["doctype"])(value)
  134. value.init_valid_columns()
  135. value.parent = self.name
  136. value.parenttype = self.doctype
  137. value.parentfield = key
  138. if value.docstatus is None:
  139. value.docstatus = 0
  140. if not getattr(value, "idx", None):
  141. value.idx = len(self.get(key) or []) + 1
  142. if not getattr(value, "name", None):
  143. value.__dict__['__islocal'] = 1
  144. return value
  145. def get_valid_dict(self, sanitize=True):
  146. d = frappe._dict()
  147. for fieldname in self.meta.get_valid_columns():
  148. d[fieldname] = self.get(fieldname)
  149. # if no need for sanitization and value is None, continue
  150. if not sanitize and d[fieldname] is None:
  151. continue
  152. df = self.meta.get_field(fieldname)
  153. if df:
  154. if df.fieldtype=="Check":
  155. if d[fieldname]==None:
  156. d[fieldname] = 0
  157. elif (not isinstance(d[fieldname], int) or d[fieldname] > 1):
  158. d[fieldname] = 1 if cint(d[fieldname]) else 0
  159. elif df.fieldtype=="Int" and not isinstance(d[fieldname], int):
  160. d[fieldname] = cint(d[fieldname])
  161. elif df.fieldtype in ("Currency", "Float", "Percent") and not isinstance(d[fieldname], float):
  162. d[fieldname] = flt(d[fieldname])
  163. elif df.fieldtype in ("Datetime", "Date") and d[fieldname]=="":
  164. d[fieldname] = None
  165. elif df.get("unique") and cstr(d[fieldname]).strip()=="":
  166. # unique empty field should be set to None
  167. d[fieldname] = None
  168. if isinstance(d[fieldname], list) and df.fieldtype != 'Table':
  169. frappe.throw(_('Value for {0} cannot be a list').format(_(df.label)))
  170. return d
  171. def init_valid_columns(self):
  172. for key in default_fields:
  173. if key not in self.__dict__:
  174. self.__dict__[key] = None
  175. if key in ("idx", "docstatus") and self.__dict__[key] is None:
  176. self.__dict__[key] = 0
  177. for key in self.get_valid_columns():
  178. if key not in self.__dict__:
  179. self.__dict__[key] = None
  180. def get_valid_columns(self):
  181. if self.doctype not in frappe.local.valid_columns:
  182. if self.doctype in ("DocField", "DocPerm") and self.parent in ("DocType", "DocField", "DocPerm"):
  183. from frappe.model.meta import get_table_columns
  184. valid = get_table_columns(self.doctype)
  185. else:
  186. valid = self.meta.get_valid_columns()
  187. frappe.local.valid_columns[self.doctype] = valid
  188. return frappe.local.valid_columns[self.doctype]
  189. def is_new(self):
  190. return self.get("__islocal")
  191. def as_dict(self, no_nulls=False, no_default_fields=False):
  192. doc = self.get_valid_dict()
  193. doc["doctype"] = self.doctype
  194. for df in self.meta.get_table_fields():
  195. children = self.get(df.fieldname) or []
  196. doc[df.fieldname] = [d.as_dict(no_nulls=no_nulls) for d in children]
  197. if no_nulls:
  198. for k in doc.keys():
  199. if doc[k] is None:
  200. del doc[k]
  201. if no_default_fields:
  202. for k in doc.keys():
  203. if k in default_fields:
  204. del doc[k]
  205. for key in ("_user_tags", "__islocal", "__onload", "_liked_by", "__run_link_triggers"):
  206. if self.get(key):
  207. doc[key] = self.get(key)
  208. return doc
  209. def as_json(self):
  210. return frappe.as_json(self.as_dict())
  211. def get_table_field_doctype(self, fieldname):
  212. return self.meta.get_field(fieldname).options
  213. def get_parentfield_of_doctype(self, doctype):
  214. fieldname = [df.fieldname for df in self.meta.get_table_fields() if df.options==doctype]
  215. return fieldname[0] if fieldname else None
  216. def db_insert(self):
  217. """INSERT the document (with valid columns) in the database."""
  218. if not self.name:
  219. # name will be set by document class in most cases
  220. set_new_name(self)
  221. if not self.creation:
  222. self.creation = self.modified = now()
  223. self.created_by = self.modifield_by = frappe.session.user
  224. d = self.get_valid_dict()
  225. columns = d.keys()
  226. try:
  227. frappe.db.sql("""insert into `tab{doctype}`
  228. ({columns}) values ({values})""".format(
  229. doctype = self.doctype,
  230. columns = ", ".join(["`"+c+"`" for c in columns]),
  231. values = ", ".join(["%s"] * len(columns))
  232. ), d.values())
  233. except Exception, e:
  234. if e.args[0]==1062:
  235. if "PRIMARY" in cstr(e.args[1]):
  236. if self.meta.autoname=="hash":
  237. # hash collision? try again
  238. self.name = None
  239. self.db_insert()
  240. return
  241. type, value, traceback = sys.exc_info()
  242. frappe.msgprint(_("Duplicate name {0} {1}").format(self.doctype, self.name))
  243. raise frappe.DuplicateEntryError, (self.doctype, self.name, e), traceback
  244. elif "Duplicate" in cstr(e.args[1]):
  245. # unique constraint
  246. self.show_unique_validation_message(e)
  247. else:
  248. raise
  249. else:
  250. raise
  251. self.set("__islocal", False)
  252. def db_update(self):
  253. if self.get("__islocal") or not self.name:
  254. self.db_insert()
  255. return
  256. d = self.get_valid_dict()
  257. # don't update name, as case might've been changed
  258. name = d['name']
  259. del d['name']
  260. columns = d.keys()
  261. try:
  262. frappe.db.sql("""update `tab{doctype}`
  263. set {values} where name=%s""".format(
  264. doctype = self.doctype,
  265. values = ", ".join(["`"+c+"`=%s" for c in columns])
  266. ), d.values() + [name])
  267. except Exception, e:
  268. if e.args[0]==1062 and "Duplicate" in cstr(e.args[1]):
  269. self.show_unique_validation_message(e)
  270. else:
  271. raise
  272. def show_unique_validation_message(self, e):
  273. type, value, traceback = sys.exc_info()
  274. fieldname, label = str(e).split("'")[-2], None
  275. # unique_first_fieldname_second_fieldname is the constraint name
  276. # created using frappe.db.add_unique
  277. if "unique_" in fieldname:
  278. fieldname = fieldname.split("_", 1)[1]
  279. df = self.meta.get_field(fieldname)
  280. if df:
  281. label = df.label
  282. frappe.msgprint(_("{0} must be unique".format(label or fieldname)))
  283. # this is used to preserve traceback
  284. raise frappe.UniqueValidationError, (self.doctype, self.name, e), traceback
  285. def db_set(self, fieldname, value=None, update_modified=True):
  286. '''Set a value in the document object, update the timestamp and update the database.
  287. WARNING: This method does not trigger controller validations and should
  288. be used very carefully.
  289. :param fieldname: fieldname of the property to be updated, or a {"field":"value"} dictionary
  290. :param value: value of the property to be updated
  291. :param update_modified: default True. updates the `modified` and `modified_by` properties
  292. '''
  293. if isinstance(fieldname, dict):
  294. self.update(fieldname)
  295. else:
  296. self.set(fieldname, value)
  297. if update_modified and (self.doctype, self.name) not in frappe.flags.currently_saving:
  298. # don't update modified timestamp if called from post save methods
  299. # like on_update or on_submit
  300. self.set("modified", now())
  301. self.set("modified_by", frappe.session.user)
  302. # to trigger email alert on value change
  303. self.run_method('before_change')
  304. frappe.db.set_value(self.doctype, self.name, fieldname, value,
  305. self.modified, self.modified_by, update_modified=update_modified)
  306. self.run_method('on_change')
  307. def db_get(self, fieldname):
  308. '''get database vale for this fieldname'''
  309. return frappe.db.get_value(self.doctype, self.name, fieldname)
  310. def update_modified(self):
  311. '''Update modified timestamp'''
  312. self.set("modified", now())
  313. frappe.db.set_value(self.doctype, self.name, 'modified', self.modified, update_modified=False)
  314. def _fix_numeric_types(self):
  315. for df in self.meta.get("fields"):
  316. if df.fieldtype == "Check":
  317. self.set(df.fieldname, cint(self.get(df.fieldname)))
  318. elif self.get(df.fieldname) is not None:
  319. if df.fieldtype == "Int":
  320. self.set(df.fieldname, cint(self.get(df.fieldname)))
  321. elif df.fieldtype in ("Float", "Currency", "Percent"):
  322. self.set(df.fieldname, flt(self.get(df.fieldname)))
  323. if self.docstatus is not None:
  324. self.docstatus = cint(self.docstatus)
  325. def _get_missing_mandatory_fields(self):
  326. """Get mandatory fields that do not have any values"""
  327. def get_msg(df):
  328. if df.fieldtype == "Table":
  329. return "{}: {}: {}".format(_("Error"), _("Data missing in table"), _(df.label))
  330. elif self.parentfield:
  331. return "{}: {} {} #{}: {}: {}".format(_("Error"), frappe.bold(_(self.doctype)),
  332. _("Row"), self.idx, _("Value missing for"), _(df.label))
  333. else:
  334. return "{}: {}: {}".format(_("Error"), _("Value missing for"), _(df.label))
  335. missing = []
  336. for df in self.meta.get("fields", {"reqd": 1}):
  337. if self.get(df.fieldname) in (None, []) or not strip_html(cstr(self.get(df.fieldname))).strip():
  338. missing.append((df.fieldname, get_msg(df)))
  339. # check for missing parent and parenttype
  340. if self.meta.istable:
  341. for fieldname in ("parent", "parenttype"):
  342. if not self.get(fieldname):
  343. missing.append((fieldname, get_msg(frappe._dict(label=fieldname))))
  344. return missing
  345. def get_invalid_links(self, is_submittable=False):
  346. '''Returns list of invalid links and also updates fetch values if not set'''
  347. def get_msg(df, docname):
  348. if self.parentfield:
  349. return "{} #{}: {}: {}".format(_("Row"), self.idx, _(df.label), docname)
  350. else:
  351. return "{}: {}".format(_(df.label), docname)
  352. invalid_links = []
  353. cancelled_links = []
  354. for df in (self.meta.get_link_fields()
  355. + self.meta.get("fields", {"fieldtype":"Dynamic Link"})):
  356. docname = self.get(df.fieldname)
  357. if docname:
  358. if df.fieldtype=="Link":
  359. doctype = df.options
  360. if not doctype:
  361. frappe.throw(_("Options not set for link field {0}").format(df.fieldname))
  362. else:
  363. doctype = self.get(df.options)
  364. if not doctype:
  365. frappe.throw(_("{0} must be set first").format(self.meta.get_label(df.options)))
  366. # MySQL is case insensitive. Preserve case of the original docname in the Link Field.
  367. # get a map of values ot fetch along with this link query
  368. # that are mapped as link_fieldname.source_fieldname in Options of
  369. # Readonly or Data or Text type fields
  370. fields_to_fetch = [
  371. _df for _df in self.meta.get_fields_to_fetch(df.fieldname)
  372. if not self.get(_df.fieldname)
  373. ]
  374. if not fields_to_fetch:
  375. # cache a single value type
  376. values = frappe._dict(name=frappe.db.get_value(doctype, docname,
  377. 'name', cache=True))
  378. else:
  379. values_to_fetch = ['name'] + [_df.options.split('.')[-1]
  380. for _df in fields_to_fetch]
  381. # don't cache if fetching other values too
  382. values = frappe.db.get_value(doctype, docname,
  383. values_to_fetch, as_dict=True)
  384. if frappe.get_meta(doctype).issingle:
  385. values.name = doctype
  386. setattr(self, df.fieldname, values.name)
  387. for _df in fields_to_fetch:
  388. setattr(self, _df.fieldname, values[_df.options.split('.')[-1]])
  389. notify_link_count(doctype, docname)
  390. if not values.name:
  391. invalid_links.append((df.fieldname, docname, get_msg(df, docname)))
  392. elif (df.fieldname != "amended_from"
  393. and (is_submittable or self.meta.is_submittable) and frappe.get_meta(doctype).is_submittable
  394. and cint(frappe.db.get_value(doctype, docname, "docstatus"))==2):
  395. cancelled_links.append((df.fieldname, docname, get_msg(df, docname)))
  396. return invalid_links, cancelled_links
  397. def _validate_selects(self):
  398. if frappe.flags.in_import:
  399. return
  400. for df in self.meta.get_select_fields():
  401. if df.fieldname=="naming_series" or not (self.get(df.fieldname) and df.options):
  402. continue
  403. options = (df.options or "").split("\n")
  404. # if only empty options
  405. if not filter(None, options):
  406. continue
  407. # strip and set
  408. self.set(df.fieldname, cstr(self.get(df.fieldname)).strip())
  409. value = self.get(df.fieldname)
  410. if value not in options and not (frappe.flags.in_test and value.startswith("_T-")):
  411. # show an elaborate message
  412. prefix = _("Row #{0}:").format(self.idx) if self.get("parentfield") else ""
  413. label = _(self.meta.get_label(df.fieldname))
  414. comma_options = '", "'.join(_(each) for each in options)
  415. frappe.throw(_('{0} {1} cannot be "{2}". It should be one of "{3}"').format(prefix, label,
  416. value, comma_options))
  417. def _validate_constants(self):
  418. if frappe.flags.in_import or self.is_new() or self.flags.ignore_validate_constants:
  419. return
  420. constants = [d.fieldname for d in self.meta.get("fields", {"set_only_once": 1})]
  421. if constants:
  422. values = frappe.db.get_value(self.doctype, self.name, constants, as_dict=True)
  423. for fieldname in constants:
  424. df = self.meta.get_field(fieldname)
  425. # This conversion to string only when fieldtype is Date
  426. if df.fieldtype == 'Date' or df.fieldtype == 'Datetime':
  427. value = str(values.get(fieldname))
  428. else:
  429. value = values.get(fieldname)
  430. if self.get(fieldname) != value:
  431. frappe.throw(_("Value cannot be changed for {0}").format(self.meta.get_label(fieldname)),
  432. frappe.CannotChangeConstantError)
  433. def _validate_length(self):
  434. if frappe.flags.in_install:
  435. return
  436. for fieldname, value in self.get_valid_dict().iteritems():
  437. df = self.meta.get_field(fieldname)
  438. if df and df.fieldtype in type_map and type_map[df.fieldtype][0]=="varchar":
  439. max_length = cint(df.get("length")) or cint(varchar_len)
  440. if len(cstr(value)) > max_length:
  441. if self.parentfield and self.idx:
  442. reference = _("{0}, Row {1}").format(_(self.doctype), self.idx)
  443. else:
  444. reference = "{0} {1}".format(_(self.doctype), self.name)
  445. frappe.throw(_("{0}: '{1}' ({3}) will get truncated, as max characters allowed is {2}")\
  446. .format(reference, _(df.label), max_length, value), frappe.CharacterLengthExceededError, title=_('Value too big'))
  447. def _validate_update_after_submit(self):
  448. # get the full doc with children
  449. db_values = frappe.get_doc(self.doctype, self.name).as_dict()
  450. for key in self.as_dict():
  451. df = self.meta.get_field(key)
  452. db_value = db_values.get(key)
  453. if df and not df.allow_on_submit and (self.get(key) or db_value):
  454. if df.fieldtype=="Table":
  455. # just check if the table size has changed
  456. # individual fields will be checked in the loop for children
  457. self_value = len(self.get(key))
  458. db_value = len(db_value)
  459. else:
  460. self_value = self.get_value(key)
  461. if self_value != db_value:
  462. frappe.throw(_("Not allowed to change {0} after submission").format(df.label),
  463. frappe.UpdateAfterSubmitError)
  464. def _sanitize_content(self):
  465. """Sanitize HTML and Email in field values. Used to prevent XSS.
  466. - Ignore if 'Ignore XSS Filter' is checked or fieldtype is 'Code'
  467. """
  468. if frappe.flags.in_install:
  469. return
  470. for fieldname, value in self.get_valid_dict().items():
  471. if not value or not isinstance(value, basestring):
  472. continue
  473. elif (u"<" not in value and u">" not in value):
  474. # doesn't look like html so no need
  475. continue
  476. elif "<!-- markdown -->" in value and not ("<script" in value or "javascript:" in value):
  477. # should be handled separately via the markdown converter function
  478. continue
  479. df = self.meta.get_field(fieldname)
  480. sanitized_value = value
  481. if df and df.get("fieldtype") in ("Data", "Code", "Small Text") and df.get("options")=="Email":
  482. sanitized_value = sanitize_email(value)
  483. elif df and (df.get("ignore_xss_filter")
  484. or (df.get("fieldtype")=="Code" and df.get("options")!="Email")
  485. or df.get("fieldtype") in ("Attach", "Attach Image")
  486. # cancelled and submit but not update after submit should be ignored
  487. or self.docstatus==2
  488. or (self.docstatus==1 and not df.get("allow_on_submit"))):
  489. continue
  490. else:
  491. sanitized_value = sanitize_html(value, linkify=df.fieldtype=='Text Editor')
  492. self.set(fieldname, sanitized_value)
  493. def _save_passwords(self):
  494. '''Save password field values in __Auth table'''
  495. if self.flags.ignore_save_passwords:
  496. return
  497. for df in self.meta.get('fields', {'fieldtype': 'Password'}):
  498. new_password = self.get(df.fieldname)
  499. if new_password and not self.is_dummy_password(new_password):
  500. # is not a dummy password like '*****'
  501. set_encrypted_password(self.doctype, self.name, new_password, df.fieldname)
  502. # set dummy password like '*****'
  503. self.set(df.fieldname, '*'*len(new_password))
  504. def get_password(self, fieldname='password', raise_exception=True):
  505. if self.get(fieldname) and not self.is_dummy_password(self.get(fieldname)):
  506. return self.get(fieldname)
  507. return get_decrypted_password(self.doctype, self.name, fieldname, raise_exception=raise_exception)
  508. def is_dummy_password(self, pwd):
  509. return ''.join(set(pwd))=='*'
  510. def precision(self, fieldname, parentfield=None):
  511. """Returns float precision for a particular field (or get global default).
  512. :param fieldname: Fieldname for which precision is required.
  513. :param parentfield: If fieldname is in child table."""
  514. from frappe.model.meta import get_field_precision
  515. if parentfield and not isinstance(parentfield, basestring):
  516. parentfield = parentfield.parentfield
  517. cache_key = parentfield or "main"
  518. if not hasattr(self, "_precision"):
  519. self._precision = frappe._dict()
  520. if cache_key not in self._precision:
  521. self._precision[cache_key] = frappe._dict()
  522. if fieldname not in self._precision[cache_key]:
  523. self._precision[cache_key][fieldname] = None
  524. doctype = self.meta.get_field(parentfield).options if parentfield else self.doctype
  525. df = frappe.get_meta(doctype).get_field(fieldname)
  526. if df.fieldtype in ("Currency", "Float", "Percent"):
  527. self._precision[cache_key][fieldname] = get_field_precision(df, self)
  528. return self._precision[cache_key][fieldname]
  529. def get_formatted(self, fieldname, doc=None, currency=None, absolute_value=False, translated=False):
  530. from frappe.utils.formatters import format_value
  531. df = self.meta.get_field(fieldname)
  532. if not df and fieldname in default_fields:
  533. from frappe.model.meta import get_default_df
  534. df = get_default_df(fieldname)
  535. val = self.get(fieldname)
  536. if translated:
  537. val = _(val)
  538. if absolute_value and isinstance(val, (int, float)):
  539. val = abs(self.get(fieldname))
  540. if not doc:
  541. doc = getattr(self, "parent_doc", None) or self
  542. return format_value(val, df=df, doc=doc, currency=currency)
  543. def is_print_hide(self, fieldname, df=None, for_print=True):
  544. """Returns true if fieldname is to be hidden for print.
  545. Print Hide can be set via the Print Format Builder or in the controller as a list
  546. of hidden fields. Example
  547. class MyDoc(Document):
  548. def __setup__(self):
  549. self.print_hide = ["field1", "field2"]
  550. :param fieldname: Fieldname to be checked if hidden.
  551. """
  552. meta_df = self.meta.get_field(fieldname)
  553. if meta_df and meta_df.get("__print_hide"):
  554. return True
  555. print_hide = 0
  556. if self.get(fieldname)==0 and not self.meta.istable:
  557. print_hide = ( df and df.print_hide_if_no_value ) or ( meta_df and meta_df.print_hide_if_no_value )
  558. if not print_hide:
  559. if df and df.print_hide is not None:
  560. print_hide = df.print_hide
  561. elif meta_df:
  562. print_hide = meta_df.print_hide
  563. return print_hide
  564. def in_format_data(self, fieldname):
  565. """Returns True if shown via Print Format::`format_data` property.
  566. Called from within standard print format."""
  567. doc = getattr(self, "parent_doc", self)
  568. if hasattr(doc, "format_data_map"):
  569. return fieldname in doc.format_data_map
  570. else:
  571. return True
  572. def reset_values_if_no_permlevel_access(self, has_access_to, high_permlevel_fields):
  573. """If the user does not have permissions at permlevel > 0, then reset the values to original / default"""
  574. to_reset = []
  575. for df in high_permlevel_fields:
  576. if df.permlevel not in has_access_to and df.fieldtype not in display_fieldtypes:
  577. to_reset.append(df)
  578. if to_reset:
  579. if self.is_new():
  580. # if new, set default value
  581. ref_doc = frappe.new_doc(self.doctype)
  582. else:
  583. # get values from old doc
  584. if self.parent:
  585. self.parent_doc.get_latest()
  586. ref_doc = [d for d in self.parent_doc.get(self.parentfield) if d.name == self.name][0]
  587. else:
  588. ref_doc = self.get_latest()
  589. for df in to_reset:
  590. self.set(df.fieldname, ref_doc.get(df.fieldname))
  591. def get_value(self, fieldname):
  592. df = self.meta.get_field(fieldname)
  593. val = self.get(fieldname)
  594. return self.cast(val, df)
  595. def cast(self, val, df):
  596. if df.fieldtype in ("Currency", "Float", "Percent"):
  597. val = flt(val)
  598. elif df.fieldtype in ("Int", "Check"):
  599. val = cint(val)
  600. elif df.fieldtype in ("Data", "Text", "Small Text", "Long Text",
  601. "Text Editor", "Select", "Link", "Dynamic Link"):
  602. val = cstr(val)
  603. elif df.fieldtype == "Date":
  604. val = getdate(val)
  605. elif df.fieldtype == "Datetime":
  606. val = get_datetime(val)
  607. elif df.fieldtype == "Time":
  608. val = to_timedelta(val)
  609. return val
  610. def _extract_images_from_text_editor(self):
  611. from frappe.utils.file_manager import extract_images_from_doc
  612. if self.doctype != "DocType":
  613. for df in self.meta.get("fields", {"fieldtype":"Text Editor"}):
  614. extract_images_from_doc(self, df.fieldname)
  615. def _filter(data, filters, limit=None):
  616. """pass filters as:
  617. {"key": "val", "key": ["!=", "val"],
  618. "key": ["in", "val"], "key": ["not in", "val"], "key": "^val",
  619. "key" : True (exists), "key": False (does not exist) }"""
  620. out = []
  621. for d in data:
  622. add = True
  623. for f in filters:
  624. fval = filters[f]
  625. if fval is True:
  626. fval = ("not None", fval)
  627. elif fval is False:
  628. fval = ("None", fval)
  629. elif not isinstance(fval, (tuple, list)):
  630. if isinstance(fval, basestring) and fval.startswith("^"):
  631. fval = ("^", fval[1:])
  632. else:
  633. fval = ("=", fval)
  634. if not frappe.compare(getattr(d, f, None), fval[0], fval[1]):
  635. add = False
  636. break
  637. if add:
  638. out.append(d)
  639. if limit and (len(out)-1)==limit:
  640. break
  641. return out