774 lines
22 KiB
Python
Executable file
774 lines
22 KiB
Python
Executable file
# Copyright (c) 2013, Web Notes Technologies Pvt. Ltd. and Contributors
|
|
# MIT License. See license.txt
|
|
|
|
from __future__ import unicode_literals
|
|
"""
|
|
Contains the Document class representing an object / record
|
|
"""
|
|
|
|
_toc = ["frappe.model.doc.Document"]
|
|
|
|
import frappe
|
|
from frappe import _
|
|
import frappe.model.meta
|
|
from frappe.utils import *
|
|
|
|
class Document:
|
|
"""
|
|
The frappe(meta-data)framework equivalent of a Database Record.
|
|
Stores,Retrieves,Updates the record in the corresponding table.
|
|
Runs the triggers required.
|
|
|
|
The `Document` class represents the basic Object-Relational Mapper (ORM). The object type is defined by
|
|
`DocType` and the object ID is represented by `name`::
|
|
|
|
Please note the anamoly in the Web Notes Framework that `ID` is always called as `name`
|
|
|
|
If both `doctype` and `name` are specified in the constructor, then the object is loaded from the database.
|
|
If only `doctype` is given, then the object is not loaded
|
|
If `fielddata` is specfied, then the object is created from the given dictionary.
|
|
|
|
**Note 1:**
|
|
|
|
The getter and setter of the object are overloaded to map to the fields of the object that
|
|
are loaded when it is instantiated.
|
|
|
|
For example: doc.name will be the `name` field and doc.owner will be the `owner` field
|
|
|
|
**Note 2 - Standard Fields:**
|
|
|
|
* `name`: ID / primary key
|
|
* `owner`: creator of the record
|
|
* `creation`: datetime of creation
|
|
* `modified`: datetime of last modification
|
|
* `modified_by` : last updating user
|
|
* `docstatus` : Status 0 - Saved, 1 - Submitted, 2- Cancelled
|
|
* `parent` : if child (table) record, this represents the parent record
|
|
* `parenttype` : type of parent record (if any)
|
|
* `parentfield` : table fieldname of parent record (if any)
|
|
* `idx` : Index (sequence) of the child record
|
|
"""
|
|
|
|
def __init__(self, doctype = None, name = None, fielddata = None):
|
|
self._roles = []
|
|
self._perms = []
|
|
self._user_defaults = {}
|
|
self._new_name_set = False
|
|
self._meta = None
|
|
|
|
if isinstance(doctype, dict):
|
|
fielddata = doctype
|
|
doctype = None
|
|
if doctype and isinstance(name, dict):
|
|
name = frappe.db.get_value(doctype, name, "name") or None
|
|
|
|
if fielddata:
|
|
self.fields = fielddata
|
|
else:
|
|
self.fields = {}
|
|
|
|
if not self.fields.has_key('name'):
|
|
self.fields['name']='' # required on save
|
|
if not self.fields.has_key('doctype'):
|
|
self.fields['doctype']='' # required on save
|
|
if not self.fields.has_key('owner'):
|
|
self.fields['owner']='' # required on save
|
|
|
|
if doctype:
|
|
self.fields['doctype'] = doctype
|
|
if name:
|
|
self.fields['name'] = name
|
|
self.__initialized = 1
|
|
|
|
if (doctype and name):
|
|
self._loadfromdb(doctype, name)
|
|
else:
|
|
if not fielddata:
|
|
self.fields['__islocal'] = 1
|
|
|
|
if not self.fields.get("docstatus"):
|
|
self.fields["docstatus"] = 0
|
|
|
|
def __nonzero__(self):
|
|
return True
|
|
|
|
def __str__(self):
|
|
return str(self.fields)
|
|
|
|
def __repr__(self):
|
|
return repr(self.fields)
|
|
|
|
def __unicode__(self):
|
|
return unicode(self.fields)
|
|
|
|
def __eq__(self, other):
|
|
if isinstance(other, Document):
|
|
return self.fields == other.fields
|
|
else:
|
|
return False
|
|
|
|
def __getstate__(self):
|
|
return self.fields
|
|
|
|
def __setstate__(self, d):
|
|
self.fields = d
|
|
|
|
def encode(self, encoding='utf-8'):
|
|
"""convert all unicode values to utf-8"""
|
|
from frappe.utils import encode_dict
|
|
encode_dict(self.fields)
|
|
|
|
def _loadfromdb(self, doctype = None, name = None):
|
|
if name: self.name = name
|
|
if doctype: self.doctype = doctype
|
|
|
|
is_single = False
|
|
try:
|
|
is_single = frappe.model.meta.is_single(self.doctype)
|
|
except Exception, e:
|
|
pass
|
|
|
|
if is_single:
|
|
self._loadsingle()
|
|
else:
|
|
try:
|
|
dataset = frappe.db.sql('select * from `tab%s` where name=%s' %
|
|
(self.doctype, "%s"), self.name)
|
|
except frappe.SQLError, e:
|
|
if e.args[0]==1146:
|
|
dataset = None
|
|
else:
|
|
raise
|
|
|
|
if not dataset:
|
|
raise frappe.DoesNotExistError, '[WNF] %s %s does not exist' % (self.doctype, self.name)
|
|
self._load_values(dataset[0], frappe.db.get_description())
|
|
|
|
def is_new(self):
|
|
return self.fields.get("__islocal")
|
|
|
|
def _load_values(self, data, description):
|
|
if '__islocal' in self.fields:
|
|
del self.fields['__islocal']
|
|
for i in range(len(description)):
|
|
v = data[i]
|
|
self.fields[description[i][0]] = frappe.db.convert_to_simple_type(v)
|
|
|
|
def _merge_values(self, data, description):
|
|
for i in range(len(description)):
|
|
v = data[i]
|
|
if v: # only if value, over-write
|
|
self.fields[description[i][0]] = frappe.db.convert_to_simple_type(v)
|
|
|
|
def _loadsingle(self):
|
|
self.name = self.doctype
|
|
self.fields.update(getsingle(self.doctype))
|
|
self.cast_floats_and_ints()
|
|
|
|
def cast_floats_and_ints(self):
|
|
for df in frappe.get_doctype(self.doctype).get_docfields():
|
|
if df.fieldtype in ("Int", "Check"):
|
|
self.fields[df.fieldname] = cint(self.fields.get(df.fieldname))
|
|
elif df.fieldtype in ("Float", "Currency"):
|
|
self.fields[df.fieldname] = flt(self.fields.get(df.fieldname))
|
|
|
|
if self.docstatus is not None:
|
|
self.docstatus = cint(self.docstatus)
|
|
|
|
def __setattr__(self, name, value):
|
|
# normal attribute
|
|
if not self.__dict__.has_key('_Document__initialized'):
|
|
self.__dict__[name] = value
|
|
elif self.__dict__.has_key(name):
|
|
self.__dict__[name] = value
|
|
else:
|
|
# field attribute
|
|
f = self.__dict__['fields']
|
|
f[name] = value
|
|
|
|
def __getattr__(self, name):
|
|
if self.__dict__.has_key(name):
|
|
return self.__dict__[name]
|
|
elif self.fields.has_key(name):
|
|
return self.fields[name]
|
|
else:
|
|
if name.startswith("__"):
|
|
raise AttributeError()
|
|
return None
|
|
|
|
def get(self, name, value=None):
|
|
return self.fields.get(name, value)
|
|
|
|
def update(self, d):
|
|
self.fields.update(d)
|
|
return self
|
|
|
|
def update_if_missing(self, d):
|
|
fields = self.get_valid_fields()
|
|
for key, value in d.iteritems():
|
|
if (key in fields) and (not self.fields.get(key)):
|
|
self.fields[key] = value
|
|
|
|
def insert(self):
|
|
self.fields['__islocal'] = 1
|
|
self.save()
|
|
return self
|
|
|
|
def save(self, new=0, check_links=1, ignore_fields=0, make_autoname=1,
|
|
keep_timestamps=False):
|
|
|
|
if new:
|
|
self.fields["__islocal"] = 1
|
|
|
|
# add missing parentinfo (if reqd)
|
|
if self.parent and not (self.parenttype and self.parentfield):
|
|
self.update_parentinfo()
|
|
|
|
if self.parent and not self.idx:
|
|
self.set_idx()
|
|
|
|
# if required, make new
|
|
if not self.meta.issingle:
|
|
if self.is_new():
|
|
r = self._insert(make_autoname=make_autoname, keep_timestamps = keep_timestamps)
|
|
if r:
|
|
return r
|
|
else:
|
|
if not frappe.db.exists(self.doctype, self.name):
|
|
frappe.msgprint(frappe._("Cannot update a non-exiting record, try inserting.") + ": " + self.doctype + " / " + self.name,
|
|
raise_exception=1)
|
|
|
|
|
|
# save the values
|
|
self._update_values(self.meta.issingle,
|
|
check_links and self.make_link_list() or {}, ignore_fields=ignore_fields,
|
|
keep_timestamps=keep_timestamps)
|
|
self._clear_temp_fields()
|
|
|
|
|
|
def _get_amended_name(self):
|
|
am_id = 1
|
|
am_prefix = self.amended_from
|
|
if frappe.db.get_value(self.doctype, self.amended_from, "amended_from"):
|
|
am_id = cint(self.amended_from.split('-')[-1]) + 1
|
|
am_prefix = '-'.join(self.amended_from.split('-')[:-1]) # except the last hyphen
|
|
|
|
self.name = am_prefix + '-' + str(am_id)
|
|
|
|
def set_new_name(self, bean=None):
|
|
if self._new_name_set:
|
|
# already set by bean
|
|
return
|
|
|
|
self._new_name_set = True
|
|
|
|
autoname = self.meta.autoname
|
|
|
|
self.localname = self.name
|
|
|
|
|
|
# amendments
|
|
if self.amended_from:
|
|
return self._get_amended_name()
|
|
|
|
# by method
|
|
else:
|
|
# get my object
|
|
if not bean:
|
|
bean = frappe.bean([self])
|
|
|
|
bean.run_method("autoname")
|
|
if self.name and self.localname != self.name:
|
|
return
|
|
|
|
# based on a field
|
|
if autoname and autoname.startswith('field:'):
|
|
n = self.fields[autoname[6:]]
|
|
if not n:
|
|
raise Exception, 'Name is required'
|
|
self.name = n.strip()
|
|
|
|
elif autoname and autoname.startswith("naming_series:"):
|
|
self.set_naming_series()
|
|
if not self.naming_series:
|
|
frappe.msgprint(frappe._("Naming Series mandatory"), raise_exception=True)
|
|
self.name = make_autoname(self.naming_series+'.#####')
|
|
|
|
# call the method!
|
|
elif autoname and autoname!='Prompt':
|
|
self.name = make_autoname(autoname, self.doctype)
|
|
|
|
# given
|
|
elif self.fields.get('__newname',''):
|
|
self.name = self.fields['__newname']
|
|
|
|
# default name for table
|
|
elif self.meta.istable:
|
|
self.name = make_autoname('#########', self.doctype)
|
|
|
|
# unable to determine a name, use global series
|
|
if not self.name:
|
|
self.name = make_autoname('#########', self.doctype)
|
|
|
|
def set_naming_series(self):
|
|
if not self.naming_series:
|
|
# pick default naming series
|
|
self.naming_series = get_default_naming_series(self.doctype)
|
|
|
|
def append_number_if_name_exists(self):
|
|
if frappe.db.exists(self.doctype, self.name):
|
|
last = frappe.db.sql("""select name from `tab{}`
|
|
where name regexp '{}-[[:digit:]]+'
|
|
order by name desc limit 1""".format(self.doctype, self.name))
|
|
|
|
if last:
|
|
count = str(cint(last[0][0].rsplit("-", 1)[1]) + 1)
|
|
else:
|
|
count = "1"
|
|
|
|
self.name = "{0}-{1}".format(self.name, count)
|
|
|
|
def set(self, key, value):
|
|
self.modified = now()
|
|
self.modified_by = frappe.session["user"]
|
|
frappe.db.set_value(self.doctype, self.name, key, value, self.modified, self.modified_by)
|
|
self.fields[key] = value
|
|
|
|
def _insert(self, make_autoname=True, keep_timestamps=False):
|
|
# set name
|
|
if make_autoname:
|
|
self.set_new_name()
|
|
|
|
# validate name
|
|
self.name = validate_name(self.doctype, self.name, self.meta.name_case)
|
|
|
|
# insert!
|
|
if not keep_timestamps:
|
|
if not self.owner:
|
|
self.owner = frappe.session['user']
|
|
self.modified_by = frappe.session['user']
|
|
if not self.creation:
|
|
self.creation = self.modified = now()
|
|
else:
|
|
self.modified = now()
|
|
|
|
frappe.db.sql("insert into `tab%(doctype)s`" % self.fields \
|
|
+ """ (name, owner, creation, modified, modified_by)
|
|
values (%(name)s, %(owner)s, %(creation)s, %(modified)s,
|
|
%(modified_by)s)""", self.fields)
|
|
|
|
def _update_single(self, link_list):
|
|
self.modified = now()
|
|
update_str, values = [], []
|
|
|
|
frappe.db.sql("delete from tabSingles where doctype=%s", self.doctype)
|
|
for f in self.fields.keys():
|
|
if not (f in ('modified', 'doctype', 'name', 'perm', 'localname', 'creation'))\
|
|
and (not f.startswith('__')): # fields not saved
|
|
|
|
# validate links
|
|
if link_list and link_list.get(f):
|
|
self.fields[f] = self._validate_link(link_list, f)
|
|
|
|
if self.fields[f]==None:
|
|
update_str.append("(%s,%s,NULL)")
|
|
values.append(self.doctype)
|
|
values.append(f)
|
|
else:
|
|
update_str.append("(%s,%s,%s)")
|
|
values.append(self.doctype)
|
|
values.append(f)
|
|
values.append(self.fields[f])
|
|
frappe.db.sql("insert into tabSingles(doctype, field, value) values %s" % (', '.join(update_str)), values)
|
|
|
|
def validate_links(self, link_list):
|
|
err_list = []
|
|
for f in self.fields.keys():
|
|
# validate links
|
|
old_val = self.fields[f]
|
|
if link_list and link_list.get(f):
|
|
self.fields[f] = self._validate_link(link_list, f)
|
|
|
|
if old_val and not self.fields[f]:
|
|
err_list.append("{}: {}".format(link_list[f][1], old_val))
|
|
|
|
return err_list
|
|
|
|
def make_link_list(self):
|
|
res = frappe.model.meta.get_link_fields(self.doctype)
|
|
|
|
link_list = {}
|
|
for i in res: link_list[i[0]] = (i[1], i[2]) # options, label
|
|
return link_list
|
|
|
|
def _validate_link(self, link_list, f):
|
|
dt = link_list[f][0]
|
|
dn = self.fields.get(f)
|
|
|
|
if not dt:
|
|
frappe.throw("Options not set for link field: " + f)
|
|
|
|
if not dt: return dn
|
|
if not dn: return None
|
|
if dt=="[Select]": return dn
|
|
if dt.lower().startswith('link:'):
|
|
dt = dt[5:]
|
|
if '\n' in dt:
|
|
dt = dt.split('\n')[0]
|
|
tmp = frappe.db.sql("""SELECT name FROM `tab%s`
|
|
WHERE name = %s""" % (dt, '%s'), (dn,))
|
|
return tmp and tmp[0][0] or ''# match case
|
|
|
|
def _update_values(self, issingle, link_list, ignore_fields=0, keep_timestamps=False):
|
|
self.validate_constants()
|
|
if issingle:
|
|
self._update_single(link_list)
|
|
else:
|
|
update_str, values = [], []
|
|
# set modified timestamp
|
|
if self.modified and not keep_timestamps:
|
|
self.modified = now()
|
|
self.modified_by = frappe.session['user']
|
|
|
|
fields_list = ignore_fields and self.get_valid_fields() or self.fields.keys()
|
|
|
|
for f in fields_list:
|
|
if (not (f in ('doctype', 'name', 'perm', 'localname',
|
|
'creation','_user_tags', "file_list", "_comments"))) and (not f.startswith('__')):
|
|
# fields not saved
|
|
|
|
# validate links
|
|
if link_list and link_list.get(f):
|
|
self.fields[f] = self._validate_link(link_list, f)
|
|
|
|
if self.fields.get(f) is None or self.fields.get(f)=='':
|
|
update_str.append("`%s`=NULL" % f)
|
|
else:
|
|
values.append(self.fields.get(f))
|
|
update_str.append("`%s`=%s" % (f, '%s'))
|
|
if values:
|
|
values.append(self.name)
|
|
r = frappe.db.sql("update `tab%s` set %s where name=%s" % \
|
|
(self.doctype, ', '.join(update_str), "%s"), values)
|
|
|
|
def get_valid_fields(self):
|
|
import frappe.model.doctype
|
|
|
|
if getattr(frappe.local, "valid_fields_map", None) is None:
|
|
frappe.local.valid_fields_map = {}
|
|
|
|
valid_fields_map = frappe.local.valid_fields_map
|
|
|
|
if not valid_fields_map.get(self.doctype):
|
|
if cint(self.meta.issingle):
|
|
doctypelist = frappe.model.doctype.get(self.doctype)
|
|
valid_fields_map[self.doctype] = doctypelist.get_fieldnames({
|
|
"fieldtype": ["not in", frappe.model.no_value_fields]})
|
|
else:
|
|
valid_fields_map[self.doctype] = \
|
|
frappe.db.get_table_columns(self.doctype)
|
|
|
|
return valid_fields_map.get(self.doctype)
|
|
|
|
def validate_constants(self):
|
|
if frappe.flags.in_import:
|
|
return
|
|
|
|
meta = frappe.get_doctype(self.doctype)
|
|
constants = [d.fieldname for d in meta.get({"set_only_once": 1})]
|
|
if constants:
|
|
values = frappe.db.get_value(self.doctype, self.name, constants, as_dict=True)
|
|
|
|
for fieldname in constants:
|
|
if self.fields.get(fieldname) != values.get(fieldname):
|
|
frappe.throw("{0}: {1}".format(_("Value cannot be changed for"),
|
|
_(meta.get_field(fieldname).label)), frappe.CannotChangeConstantError)
|
|
|
|
@property
|
|
def meta(self):
|
|
if not self._meta:
|
|
self._meta = frappe.db.get_value("DocType", self.doctype, "*", as_dict=True) \
|
|
or frappe._dict()
|
|
|
|
return self._meta
|
|
|
|
def update_parentinfo(self):
|
|
"""update parent type and parent field, if not explicitly specified"""
|
|
|
|
tmp = frappe.db.sql("""select parent, fieldname from tabDocField
|
|
where fieldtype='Table' and options=%s""", (self.doctype,))
|
|
|
|
if len(tmp)==0:
|
|
raise Exception, 'Incomplete parent info in child table (%s, %s)' \
|
|
% (self.doctype, self.fields.get('name', '[new]'))
|
|
|
|
elif len(tmp)>1:
|
|
raise Exception, 'Ambiguous parent info (%s, %s)' \
|
|
% (self.doctype, self.fields.get('name', '[new]'))
|
|
|
|
else:
|
|
self.parenttype = tmp[0][0]
|
|
self.parentfield = tmp[0][1]
|
|
|
|
def set_idx(self):
|
|
"""set idx"""
|
|
self.idx = (frappe.db.sql("""select max(idx) from `tab%s`
|
|
where parent=%s and parentfield=%s""" % (self.doctype, '%s', '%s'),
|
|
(self.parent, self.parentfield))[0][0] or 0) + 1
|
|
|
|
def _clear_temp_fields(self):
|
|
# clear temp stuff
|
|
keys = self.fields.keys()
|
|
for f in keys:
|
|
if f.startswith('__'):
|
|
del self.fields[f]
|
|
|
|
def clear_table(self, doclist, tablefield, save=0):
|
|
"""
|
|
Clears the child records from the given `doclist` for a particular `tablefield`
|
|
"""
|
|
from frappe.model.utils import getlist
|
|
|
|
table_list = getlist(doclist, tablefield)
|
|
|
|
delete_list = [d.name for d in table_list]
|
|
|
|
if delete_list:
|
|
#filter doclist
|
|
doclist = filter(lambda d: d.name not in delete_list, doclist)
|
|
|
|
# delete from db
|
|
frappe.db.sql("""\
|
|
delete from `tab%s`
|
|
where parent=%s and parenttype=%s"""
|
|
% (table_list[0].doctype, '%s', '%s'),
|
|
(self.name, self.doctype))
|
|
|
|
self.fields['__unsaved'] = 1
|
|
|
|
return frappe.doclist(doclist)
|
|
|
|
def addchild(self, fieldname, childtype = '', doclist=None):
|
|
"""
|
|
Returns a child record of the give `childtype`.
|
|
|
|
* if local is set, it does not save the record
|
|
* if doclist is passed, it append the record to the doclist
|
|
"""
|
|
from frappe.model.doc import Document
|
|
d = Document()
|
|
d.parent = self.name
|
|
d.parenttype = self.doctype
|
|
d.parentfield = fieldname
|
|
d.doctype = childtype
|
|
d.docstatus = 0;
|
|
d.name = ''
|
|
d.owner = frappe.session['user']
|
|
d.fields['__islocal'] = 1 # for Client to identify unsaved doc
|
|
|
|
if doclist != None:
|
|
doclist.append(d)
|
|
|
|
return d
|
|
|
|
def get_values(self):
|
|
"""get non-null fields dict withouth standard fields"""
|
|
from frappe.model import default_fields
|
|
ret = {}
|
|
for key in self.fields:
|
|
if key not in default_fields and self.fields[key]:
|
|
ret[key] = self.fields[key]
|
|
|
|
return ret
|
|
|
|
def get_db_value(self, key):
|
|
return frappe.db.get_value(self.doctype, self.name, key)
|
|
|
|
def addchild(parent, fieldname, childtype = '', doclist=None):
|
|
"""
|
|
|
|
Create a child record to the parent doc.
|
|
|
|
Example::
|
|
|
|
c = Document('Contact','ABC')
|
|
d = addchild(c, 'contact_updates', 'Contact Update')
|
|
d.last_updated = 'Phone call'
|
|
d.save(1)
|
|
"""
|
|
return parent.addchild(fieldname, childtype, doclist)
|
|
|
|
def make_autoname(key, doctype=''):
|
|
"""
|
|
Creates an autoname from the given key:
|
|
|
|
**Autoname rules:**
|
|
|
|
* The key is separated by '.'
|
|
* '####' represents a series. The string before this part becomes the prefix:
|
|
Example: ABC.#### creates a series ABC0001, ABC0002 etc
|
|
* 'MM' represents the current month
|
|
* 'YY' and 'YYYY' represent the current year
|
|
|
|
|
|
*Example:*
|
|
|
|
* DE/./.YY./.MM./.##### will create a series like
|
|
DE/09/01/0001 where 09 is the year, 01 is the month and 0001 is the series
|
|
"""
|
|
if key=="hash":
|
|
return frappe.generate_hash(doctype)
|
|
|
|
if not "#" in key:
|
|
key = key + ".#####"
|
|
|
|
n = ''
|
|
l = key.split('.')
|
|
series_set = False
|
|
today = now_datetime()
|
|
|
|
for e in l:
|
|
en = ''
|
|
if e.startswith('#'):
|
|
if not series_set:
|
|
digits = len(e)
|
|
en = getseries(n, digits, doctype)
|
|
series_set = True
|
|
elif e=='YY':
|
|
en = today.strftime('%y')
|
|
elif e=='MM':
|
|
en = today.strftime('%m')
|
|
elif e=='DD':
|
|
en = today.strftime("%d")
|
|
elif e=='YYYY':
|
|
en = today.strftime('%Y')
|
|
else: en = e
|
|
n+=en
|
|
return n
|
|
|
|
def getseries(key, digits, doctype=''):
|
|
# series created ?
|
|
current = frappe.db.sql("select `current` from `tabSeries` where name=%s for update", (key,))
|
|
if current and current[0][0] is not None:
|
|
current = current[0][0]
|
|
# yes, update it
|
|
frappe.db.sql("update tabSeries set current = current+1 where name=%s", (key,))
|
|
current = cint(current) + 1
|
|
else:
|
|
# no, create it
|
|
frappe.db.sql("insert into tabSeries (name, current) values (%s, 1)", (key,))
|
|
current = 1
|
|
return ('%0'+str(digits)+'d') % current
|
|
|
|
def getchildren(name, childtype, field='', parenttype='', from_doctype=0):
|
|
import frappe
|
|
from frappe.model.doclist import DocList
|
|
|
|
condition = ""
|
|
values = []
|
|
|
|
if field:
|
|
condition += ' and parentfield=%s '
|
|
values.append(field)
|
|
if parenttype:
|
|
condition += ' and parenttype=%s '
|
|
values.append(parenttype)
|
|
|
|
dataset = frappe.db.sql("""select * from `tab%s` where parent=%s %s order by idx""" \
|
|
% (childtype, "%s", condition), tuple([name]+values))
|
|
desc = frappe.db.get_description()
|
|
|
|
l = DocList()
|
|
|
|
for i in dataset:
|
|
d = Document()
|
|
d.doctype = childtype
|
|
d._load_values(i, desc)
|
|
l.append(d)
|
|
|
|
return l
|
|
|
|
def check_page_perm(doc):
|
|
if doc.name=='Login Page':
|
|
return
|
|
if doc.publish:
|
|
return
|
|
|
|
if not frappe.db.sql("select name from `tabPage Role` where parent=%s and role='Guest'", (doc.name,)):
|
|
frappe.response['403'] = 1
|
|
raise frappe.PermissionError, '[WNF] No read permission for %s %s' % ('Page', doc.name)
|
|
|
|
def get(dt, dn='', with_children = 1, from_controller = 0):
|
|
"""
|
|
Returns a doclist containing the main record and all child records
|
|
"""
|
|
import frappe
|
|
import frappe.model
|
|
from frappe.model.doclist import DocList
|
|
|
|
dn = dn or dt
|
|
|
|
# load the main doc
|
|
doc = Document(dt, dn)
|
|
|
|
if dt=='Page' and frappe.session['user'] == 'Guest':
|
|
check_page_perm(doc)
|
|
|
|
if not with_children:
|
|
# done
|
|
return DocList([doc,])
|
|
|
|
# get all children types
|
|
tablefields = frappe.model.meta.get_table_fields(dt)
|
|
|
|
# load chilren
|
|
doclist = DocList([doc,])
|
|
for t in tablefields:
|
|
doclist += getchildren(doc.name, t[0], t[1], dt)
|
|
|
|
return doclist
|
|
|
|
def getsingle(doctype):
|
|
"""get single doc as dict"""
|
|
dataset = frappe.db.sql("select field, value from tabSingles where doctype=%s", (doctype,))
|
|
return dict(dataset)
|
|
|
|
def copy_common_fields(from_doc, to_doc):
|
|
from frappe.model import default_fields
|
|
doctype_list = frappe.get_doctype(to_doc.doctype)
|
|
|
|
for fieldname, value in from_doc.fields.items():
|
|
if fieldname in default_fields:
|
|
continue
|
|
|
|
if doctype_list.get_field(fieldname) and to_doc.fields[fieldname] != value:
|
|
to_doc.fields[fieldname] = value
|
|
|
|
def validate_name(doctype, name, case=None, merge=False):
|
|
if not merge:
|
|
if frappe.db.sql('select name from `tab%s` where name=%s' % (doctype,'%s'), (name,)):
|
|
raise NameError, 'Name %s already exists' % name
|
|
|
|
# no name
|
|
if not name: return 'No Name Specified for %s' % doctype
|
|
|
|
# new..
|
|
if name.startswith('New '+doctype):
|
|
raise NameError, 'There were some errors setting the name, please contact the administrator'
|
|
|
|
if case=='Title Case': name = name.title()
|
|
if case=='UPPER CASE': name = name.upper()
|
|
|
|
name = name.strip() # no leading and trailing blanks
|
|
|
|
return name
|
|
|
|
def get_default_naming_series(doctype):
|
|
"""get default value for `naming_series` property"""
|
|
from frappe.model.doctype import get_property
|
|
naming_series = get_property(doctype, "options", "naming_series")
|
|
if naming_series:
|
|
naming_series = naming_series.split("\n")
|
|
return naming_series[0] or naming_series[1]
|
|
else:
|
|
return None
|