You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

824 line
24 KiB

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