MyModel.php 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634
  1. <?php
  2. App::uses('Model', 'Model');
  3. App::uses('Utility', 'Tools.Utility');
  4. App::uses('Hash', 'Utility');
  5. /**
  6. * Model enhancements for Cake2
  7. *
  8. * @author Mark Scherer
  9. * @license MIT
  10. */
  11. class MyModel extends Model {
  12. public $recursive = -1;
  13. public $actsAs = array('Containable');
  14. /**
  15. * MyModel::__construct()
  16. *
  17. * @param integer $id
  18. * @param string $table
  19. * @param string $ds
  20. */
  21. public function __construct($id = false, $table = null, $ds = null) {
  22. parent::__construct($id, $table, $ds);
  23. // enable caching
  24. if (!Configure::read('Cache.disable') && Cache::config('sql') === false) {
  25. if (!file_exists(CACHE . 'sql')) {
  26. mkdir(CACHE . 'sql', CHOWN_PUBLIC);
  27. }
  28. Cache::config('sql', array(
  29. 'engine' => 'File',
  30. 'serialize' => true,
  31. 'prefix' => '',
  32. 'path' => CACHE . 'sql' . DS,
  33. 'duration' => '+1 day'
  34. ));
  35. }
  36. if (!Configure::read('Model.disablePrefixing')) {
  37. $this->prefixOrderProperty();
  38. }
  39. // Get a notice if there is an AppModel instance instead of a real Model (in those cases usually a dev error!)
  40. if (!is_a($this, $this->name) && $this->displayField !== $this->primaryKey && $this->useDbConfig === 'default'
  41. && !Configure::read('Core.disableModelInstanceNotice')) {
  42. trigger_error('AppModel instance! Expected: ' . $this->name);
  43. }
  44. }
  45. /**
  46. * Prefixes the order property with the actual alias if its a string or array.
  47. *
  48. * The core fails on using the proper prefix when building the query with two
  49. * different tables.
  50. *
  51. * @return void
  52. */
  53. public function prefixOrderProperty() {
  54. if (is_string($this->order)) {
  55. $this->order = $this->prefixAlias($this->order);
  56. }
  57. if (is_array($this->order)) {
  58. foreach ($this->order as $key => $value) {
  59. if (is_numeric($key)) {
  60. $this->order[$key] = $this->prefixAlias($value);
  61. } else {
  62. $newKey = $this->prefixAlias($key);
  63. $this->order[$newKey] = $value;
  64. if ($newKey !== $key) {
  65. unset($this->order[$key]);
  66. }
  67. }
  68. }
  69. }
  70. }
  71. /**
  72. * Checks if a string of a field name contains a dot if not it will add it and add the alias prefix.
  73. *
  74. * @param string
  75. * @return string
  76. */
  77. public function prefixAlias($string) {
  78. if (strpos($string, '.') === false) {
  79. return $this->alias . '.' . $string;
  80. }
  81. return $string;
  82. }
  83. /**
  84. * Deconstructs a complex data type (array or object) into a single field value.
  85. * BUGFIXED VERSION - autodetects type and allows manual override
  86. *
  87. * @param string $field The name of the field to be deconstructed
  88. * @param array|object $data An array or object to be deconstructed into a field
  89. * @return mixed The resulting data that should be assigned to a field
  90. */
  91. public function deconstruct($field, $data, $type = null) {
  92. if (!is_array($data)) {
  93. return $data;
  94. }
  95. if ($type === null) {
  96. $type = $this->getColumnType($field);
  97. }
  98. if ($type === null) {
  99. //try to autodetect
  100. if (isset($data['day']) || isset($data['month']) || isset($data['year'])) {
  101. $type = 'date';
  102. }
  103. if (isset($data['hour']) || isset($data['min']) || isset($data['sec'])) {
  104. $type .= 'time';
  105. }
  106. }
  107. if (in_array($type, array('datetime', 'timestamp', 'date', 'time'))) {
  108. $useNewDate = (isset($data['year']) || isset($data['month']) ||
  109. isset($data['day']) || isset($data['hour']) || isset($data['minute']));
  110. $dateFields = array('Y' => 'year', 'm' => 'month', 'd' => 'day', 'H' => 'hour', 'i' => 'min', 's' => 'sec');
  111. $timeFields = array('H' => 'hour', 'i' => 'min', 's' => 'sec');
  112. $date = array();
  113. if (isset($data['meridian']) && empty($data['meridian'])) {
  114. return null;
  115. }
  116. if (
  117. isset($data['hour']) &&
  118. isset($data['meridian']) &&
  119. !empty($data['hour']) &&
  120. $data['hour'] != 12 &&
  121. 'pm' == $data['meridian']
  122. ) {
  123. $data['hour'] = $data['hour'] + 12;
  124. }
  125. if (isset($data['hour']) && isset($data['meridian']) && $data['hour'] == 12 && 'am' == $data['meridian']) {
  126. $data['hour'] = '00';
  127. }
  128. if ($type === 'time') {
  129. foreach ($timeFields as $key => $val) {
  130. if (!isset($data[$val]) || $data[$val] === '0' || $data[$val] === '00') {
  131. $data[$val] = '00';
  132. } elseif ($data[$val] !== '') {
  133. $data[$val] = sprintf('%02d', $data[$val]);
  134. }
  135. if (!empty($data[$val])) {
  136. $date[$key] = $data[$val];
  137. } else {
  138. return null;
  139. }
  140. }
  141. }
  142. if ($type === 'datetime' || $type === 'timestamp' || $type === 'date') {
  143. foreach ($dateFields as $key => $val) {
  144. if ($val === 'hour' || $val === 'min' || $val === 'sec') {
  145. if (!isset($data[$val]) || $data[$val] === '0' || $data[$val] === '00') {
  146. $data[$val] = '00';
  147. } else {
  148. $data[$val] = sprintf('%02d', $data[$val]);
  149. }
  150. }
  151. if (!isset($data[$val]) || isset($data[$val]) && (empty($data[$val]) || $data[$val][0] === '-')) {
  152. return null;
  153. }
  154. if (isset($data[$val]) && !empty($data[$val])) {
  155. $date[$key] = $data[$val];
  156. }
  157. }
  158. }
  159. if ($useNewDate && !empty($date)) {
  160. $format = $this->getDataSource()->columns[$type]['format'];
  161. foreach (array('m', 'd', 'H', 'i', 's') as $index) {
  162. if (isset($date[$index])) {
  163. $date[$index] = sprintf('%02d', $date[$index]);
  164. }
  165. }
  166. return str_replace(array_keys($date), array_values($date), $format);
  167. }
  168. }
  169. return $data;
  170. }
  171. /**
  172. * The main method for any enumeration, should be called statically
  173. * Now also supports reordering/filtering
  174. *
  175. * @link http://www.dereuromark.de/2010/06/24/static-enums-or-semihardcoded-attributes/
  176. * @param string $value or array $keys or NULL for complete array result
  177. * @param array $options (actual data)
  178. * @return mixed string/array
  179. */
  180. public static function enum($value, $options, $default = null) {
  181. if ($value !== null && !is_array($value)) {
  182. if (array_key_exists($value, $options)) {
  183. return $options[$value];
  184. }
  185. return $default;
  186. } elseif ($value !== null) {
  187. $newOptions = array();
  188. foreach ($value as $v) {
  189. $newOptions[$v] = $options[$v];
  190. }
  191. return $newOptions;
  192. }
  193. return $options;
  194. }
  195. /**
  196. * @return string Error message with error number
  197. */
  198. public function lastError() {
  199. $db = $this->getDataSource();
  200. return $db->lastError();
  201. }
  202. /**
  203. * Combine virtual fields with fields values of find()
  204. * USAGE:
  205. * $this->Model->find('all', array('fields' => $this->Model->virtualFields('full_name')));
  206. * Also adds the field to the virtualFields array of the model (for correct result)
  207. * TODO: adding of fields only temperory!
  208. *
  209. * @param array $virtualFields to include
  210. * @return array
  211. */
  212. public function virtualFields($fields = array()) {
  213. $res = array();
  214. foreach ((array)$fields as $field => $sql) {
  215. if (is_int($field)) {
  216. $field = $sql;
  217. $sql = null;
  218. }
  219. $plugin = $model = null;
  220. if (($pos = strrpos($field, '.')) !== false) {
  221. $model = substr($field, 0, $pos);
  222. $field = substr($field, $pos + 1);
  223. if (($pos = strrpos($model, '.')) !== false) {
  224. list($plugin, $model) = pluginSplit($model);
  225. }
  226. }
  227. if (empty($model)) {
  228. $model = $this->alias;
  229. if ($sql === null) {
  230. $sql = $this->virtualFields[$field];
  231. } else {
  232. $this->virtualFields[$field] = $sql;
  233. }
  234. } else {
  235. if (!isset($this->$model)) {
  236. $fullModelName = ($plugin ? $plugin . '.' : '') . $model;
  237. $this->$model = ClassRegistry::init($fullModelName);
  238. }
  239. if ($sql === null) {
  240. $sql = $this->$model->virtualFields[$field];
  241. } else {
  242. $this->$model->virtualFields[$field] = $sql;
  243. }
  244. }
  245. $res[] = $sql . ' AS ' . $model . '__' . $field;
  246. }
  247. return $res;
  248. }
  249. /**
  250. * HIGHLY EXPERIMENTAL
  251. * manually escape value for updateAll() etc
  252. *
  253. * @return string
  254. */
  255. public function escapeValue($value) {
  256. if ($value === null || is_numeric($value)) {
  257. return $value;
  258. }
  259. if (is_bool($value)) {
  260. return (int)$value;
  261. }
  262. return "'" . $value . "'";
  263. }
  264. /**
  265. * HIGHLY EXPERIMENTAL
  266. *
  267. * @see http://cakephp.lighthouseapp.com/projects/42648/tickets/1799-model-should-have-escapefield-method
  268. * @return string
  269. */
  270. public function value($content) {
  271. $db = $this->getDatasource();
  272. return $db->value($content);
  273. }
  274. /**
  275. * TODO: move to behavior (Incremental)
  276. *
  277. * @param mixed id (single string)
  278. * @param options:
  279. * - step (defaults to 1)
  280. * - current (if none it will get it from db)
  281. * - reset (if true, it will be set to 0)
  282. * - field (defaults to 'count')
  283. * - modify (if true if will affect modified timestamp)
  284. * - timestampField (if provided it will be filled with NOW())
  285. * @return See Model::save()
  286. */
  287. public function up($id, $customOptions = array()) {
  288. $step = 1;
  289. if (isset($customOptions['step'])) {
  290. $step = $customOptions['step'];
  291. }
  292. $field = 'count';
  293. if (isset($customOptions['field'])) {
  294. $field = $customOptions['field'];
  295. }
  296. if (isset($customOptions['reset'])) {
  297. $currentValue = $step = 0;
  298. } elseif (!isset($customOptions['current'])) {
  299. $currentValue = $this->field($field, array($this->alias . '.id' => $id));
  300. if ($currentValue === false) {
  301. return false;
  302. }
  303. } else {
  304. $currentValue = $customOptions['current'];
  305. }
  306. $value = (int)$currentValue + (int)$step;
  307. $data = array($field => $value);
  308. if (empty($customOptions['modify'])) {
  309. $data['modified'] = false;
  310. }
  311. if (!empty($customOptions['timestampField'])) {
  312. $data[$customOptions['timestampField']] = date(FORMAT_DB_DATETIME);
  313. }
  314. $this->id = $id;
  315. return $this->save($data, false);
  316. }
  317. /**
  318. * Return the next auto increment id from the current table
  319. * UUIDs will return false
  320. *
  321. * @return integer next auto increment value or False on failure
  322. */
  323. public function getNextAutoIncrement() {
  324. $query = "SHOW TABLE STATUS WHERE name = '" . $this->tablePrefix . $this->table . "'";
  325. $result = $this->query($query);
  326. if (!isset($result[0]['TABLES']['Auto_increment'])) {
  327. return false;
  328. }
  329. return (int)$result[0]['TABLES']['Auto_increment'];
  330. }
  331. /**
  332. * Fix for non atomic queries (MyISAM etc) and saveAll to still return just the boolean result
  333. * Otherwise you would have to iterate over all result values to find out if the save was successful.
  334. *
  335. * Use Configure::read('Model.atomic') to modify atomic behavior.
  336. * Additional options:
  337. *
  338. * - returnArray: bool
  339. *
  340. * @param mixed $data
  341. * @param array $options
  342. * @return boolean Success
  343. */
  344. public function saveAll($data = null, $options = array()) {
  345. if (!isset($options['atomic']) && Configure::read('Model.atomic') !== null) {
  346. $options['atomic'] = (bool)Configure::read('Model.atomic');
  347. }
  348. $res = parent::saveAll($data, $options);
  349. if (is_array($res) && empty($options['returnArray'])) {
  350. $res = Utility::isValidSaveAll($res);
  351. }
  352. return $res;
  353. }
  354. /**
  355. * Enables HABTM-Validation
  356. * e.g. with
  357. * 'rule' => array('multiple', array('min' => 2))
  358. *
  359. * @return boolean Success
  360. */
  361. public function beforeValidate($options = array()) {
  362. foreach ($this->hasAndBelongsToMany as $k => $v) {
  363. if (isset($this->data[$k][$k])) {
  364. $this->data[$this->alias][$k] = $this->data[$k][$k];
  365. }
  366. }
  367. return parent::beforeValidate($options);
  368. }
  369. /**
  370. * @param params
  371. * - key: functioName or other key used
  372. * @return boolean Success
  373. */
  374. public function deleteCache($key = null) {
  375. $key = Inflector::underscore($key);
  376. if (!empty($key)) {
  377. return Cache::delete(strtolower(Inflector::underscore($this->alias)) . '__' . $key, 'sql');
  378. }
  379. return Cache::clear(false, 'sql');
  380. }
  381. /**
  382. * Generates a SQL subquery snippet to be used in your actual query.
  383. * Your subquery snippet needs to return a single value or flat array of values.
  384. *
  385. * Example:
  386. *
  387. * $this->Model->find('first', array(
  388. * 'conditions' => array('NOT' => array('some_id' => $this->Model->subquery(...)))
  389. * ))
  390. *
  391. * Note: You might have to set `autoFields` to false in order to retrieve only the fields you request:
  392. * http://book.cakephp.org/2.0/en/core-libraries/behaviors/containable.html#containablebehavior-options
  393. *
  394. * @param string $type The type of the query ('count'/'all'/'first' - first only works with some mysql versions)
  395. * @param array $options The options array
  396. * @param string $alias You can use this intead of $options['alias'] if you want
  397. * @param boolean $parenthesise Add parenthesis before and after
  398. * @return string result sql snippet of the query to run
  399. * @modified Mark Scherer (cake2.x ready and improvements)
  400. * @link http://bakery.cakephp.org/articles/lucaswxp/2011/02/11/easy_and_simple_subquery_cakephp
  401. */
  402. public function subquery($type, $options = array(), $alias = null, $parenthesise = true) {
  403. if ($alias === null) {
  404. $alias = 'Sub' . $this->alias . '';
  405. }
  406. $fields = array($alias . '.id');
  407. $limit = null;
  408. switch ($type) {
  409. case 'count':
  410. $fields = array('COUNT(*)');
  411. break;
  412. case 'first':
  413. $limit = 1;
  414. break;
  415. }
  416. $dbo = $this->getDataSource();
  417. $default = array(
  418. 'fields' => $fields,
  419. 'table' => $dbo->fullTableName($this),
  420. 'alias' => $alias,
  421. 'limit' => $limit,
  422. 'offset' => null,
  423. 'joins' => array(),
  424. 'conditions' => array(),
  425. 'order' => null,
  426. 'group' => null
  427. );
  428. $params = array_merge($default, $options);
  429. $subQuery = trim($dbo->buildStatement($params, $this));
  430. if ($parenthesise) {
  431. $subQuery = '(' . $subQuery . ')';
  432. }
  433. return $subQuery;
  434. }
  435. /**
  436. * Wrapper find() to cache sql queries.
  437. *
  438. * @param array $conditions
  439. * @param array $fields
  440. * @param string $order
  441. * @param string $recursive
  442. * @return array
  443. */
  444. public function find($type = null, $query = array()) {
  445. // reset/delete
  446. if (!empty($query['reset'])) {
  447. if (!empty($query['cache'])) {
  448. if (is_array($query['cache'])) {
  449. $key = $query['cache'][0];
  450. } else {
  451. $key = $query['cache'];
  452. if ($key === true) {
  453. $backtrace = debug_backtrace();
  454. $key = $backtrace[1]['function'];
  455. }
  456. }
  457. $this->deleteCache($key);
  458. }
  459. }
  460. // custom fixes
  461. if (is_string($type)) {
  462. switch ($type) {
  463. case 'count':
  464. if (isset($query['fields'])) {
  465. unset($query['fields']);
  466. }
  467. break;
  468. default:
  469. }
  470. }
  471. // having and group clauses enhancement
  472. if (is_array($query) && !empty($query['having']) && !empty($query['group'])) {
  473. if (!is_array($query['group'])) {
  474. $query['group'] = array($query['group']);
  475. }
  476. $ds = $this->getDataSource();
  477. $having = $ds->conditions($query['having'], true, false);
  478. $query['group'][count($query['group']) - 1] .= " HAVING $having";
  479. } /* elseif (is_array($query) && !empty($query['having'])) {
  480. $ds = $this->getDataSource();
  481. $having = $ds->conditions($query['having'], true, false);
  482. $query['conditions'][] = '1=1 HAVING '.$having;
  483. }
  484. */
  485. // find
  486. if (!Configure::read('Cache.disable') && Configure::read('Cache.check') && !empty($query['cache'])) {
  487. if (is_array($query['cache'])) {
  488. $key = $query['cache'][0];
  489. $expires = DAY;
  490. if (!empty($query['cache'][1])) {
  491. $expires = $query['cache'][1];
  492. }
  493. } else {
  494. $key = $query['cache'];
  495. if ($key === true) {
  496. $backtrace = debug_backtrace();
  497. $key = $backtrace[1]['function'];
  498. }
  499. $expires = DAY;
  500. }
  501. $options = array('prefix' => strtolower(Inflector::underscore($this->alias)) . '__', );
  502. if (!empty($expires)) {
  503. $options['duration'] = $expires;
  504. }
  505. if (!Configure::read('Cache.disable')) {
  506. Cache::config('sql', $options);
  507. $key = Inflector::underscore($key);
  508. $results = Cache::read($key, 'sql');
  509. }
  510. if ($results === null) {
  511. $results = parent::find($type, $query);
  512. Cache::write($key, $results, 'sql');
  513. }
  514. return $results;
  515. }
  516. // Without caching
  517. return parent::find($type, $query);
  518. }
  519. /**
  520. * This code will add formatted list functionallity to find you can easy replace the $this->Model->find('list'); with $this->Model->find('formattedlist', array('fields' => array('Model.id', 'Model.field1', 'Model.field2', 'Model.field3'), 'format' => '%s-%s %s')); and get option tag output of: Model.field1-Model.field2 Model.field3. Even better part is being able to setup your own format for the output!
  521. *
  522. * @see http://bakery.cakephp.org/articles/view/add-formatted-lists-to-your-appmodel
  523. * @deprecated
  524. * added Caching
  525. */
  526. protected function _find($type, $options = array()) {
  527. $res = false;
  528. if ($res === false) {
  529. if (isset($options['cache'])) {
  530. unset($options['cache']);
  531. }
  532. if (!isset($options['recursive'])) {
  533. //$options['recursive'] = -1;
  534. }
  535. switch ($type) {
  536. // @see http://bakery.cakephp.org/deu/articles/nate/2010/10/10/quick-tipp_-_doing_ad-hoc-joins_bei_model_find
  537. case 'matches':
  538. if (!isset($options['joins'])) {
  539. $options['joins'] = array();
  540. }
  541. if (!isset($options['model']) || !isset($options['scope'])) {
  542. break;
  543. }
  544. $assoc = $this->hasAndBelongsToMany[$options['model']];
  545. $bind = "{$assoc['with']}.{$assoc['foreignKey']} = {$this->alias}.{$this->primaryKey}";
  546. $options['joins'][] = array(
  547. 'table' => $assoc['joinTable'],
  548. 'alias' => $assoc['with'],
  549. 'type' => 'inner',
  550. 'foreignKey' => false,
  551. 'conditions' => array($bind)
  552. );
  553. $bind = $options['model'] . '.' . $this->{$options['model']}->primaryKey . ' = ';
  554. $bind .= "{$assoc['with']}.{$assoc['associationForeignKey']}";
  555. $options['joins'][] = array(
  556. 'table' => $this->{$options['model']}->table,
  557. 'alias' => $options['model'],
  558. 'type' => 'inner',
  559. 'foreignKey' => false,
  560. 'conditions' => array($bind) + (array)$options['scope'],
  561. );
  562. unset($options['model'], $options['scope']);
  563. $type = 'all';
  564. break;
  565. // probably deprecated since "virtual fields" in 1.3
  566. case 'formattedlist':
  567. if (!isset($options['fields']) || count($options['fields']) < 3) {
  568. $res = parent::find('list', $options);
  569. break;
  570. }
  571. $this->recursive = -1;
  572. //setup formating
  573. $format = '';
  574. if (!isset($options['format'])) {
  575. for ($i = 0; $i < (count($options['fields']) - 1); $i++) $format .= '%s ';
  576. $format = substr($format, 0, -1);
  577. } else {
  578. $format = $options['format'];
  579. }
  580. //get data
  581. $list = parent::find('all', $options);
  582. // remove model alias from strings to only get field names
  583. $tmpPath2[] = $format;
  584. for ($i = 1; $i <= (count($options['fields']) - 1); $i++) {
  585. $field[$i] = str_replace($this->alias . '.', '', $options['fields'][$i]);
  586. $tmpPath2[] = '{n}.' . $this->alias . '.' . $field[$i];
  587. }
  588. //do the magic?? read the code...
  589. $res = Hash::combine($list, '{n}.' . $this->alias . '.' . $this->primaryKey, $tmpPath2);
  590. break;
  591. default:
  592. $res = parent::find($type, $options);
  593. }
  594. if (!empty($this->useCache)) {
  595. Cache::write($this->cacheName, $res, $this->cacheConfig);
  596. if (Configure::read('debug') > 0) {
  597. $this->log('WRITE (' . $this->cacheConfig . '): ' . $this->cacheName, 'cache');
  598. }
  599. }
  600. } else {
  601. if (Configure::read('debug') > 0) {
  602. $this->log('READ (' . $this->cacheConfig . '): ' . $this->cacheName, 'cache');
  603. }
  604. }
  605. return $res;
  606. }
  607. /**
  608. * Core-fix for multiple sort orders
  609. *
  610. * @param addiotional 'scope'=>array(field,order) - value is retrieved by (submitted) primary key
  611. * @return mixed
  612. * TODO: fix it
  613. */
  614. protected function _findNeighbors($state, $query, $results = array()) {
  615. return parent::_findNeighbors($state, $query, $results);
  616. if (isset($query['scope'])) {
  617. //TODO
  618. }
  619. return parent::find($type, $options);
  620. }
  621. /**
  622. * @param mixed $id: id only, or request array
  623. * @param array $options
  624. * - filter: open/closed/none
  625. * - field (sortField, if not id)
  626. * - reverse: sortDirection (0=normalAsc/1=reverseDesc)
  627. * - displayField: ($this->displayField, if empty)
  628. * @param array $qryOptions
  629. * - recursive (defaults to -1)
  630. * TODO: try to use core function, TRY TO ALLOW MULTIPLE SORT FIELDS
  631. * @return array
  632. */
  633. public function neighbors($id = null, $options = array(), $qryOptions = array()) {
  634. $sortField = (!empty($options['field']) ? $options['field'] : 'created');
  635. $normalDirection = (!empty($options['reverse']) ? false : true);
  636. $sortDirWord = $normalDirection ? array('ASC', 'DESC') : array('DESC', 'ASC');
  637. $sortDirSymb = $normalDirection ? array('>=', '<=') : array('<=', '>=');
  638. $displayField = (!empty($options['displayField']) ? $options['displayField'] : $this->displayField);
  639. if (is_array($id)) {
  640. $data = $id;
  641. $id = $data[$this->alias][$this->primaryKey];
  642. } elseif ($id === null) {
  643. $id = $this->id;
  644. }
  645. if (!empty($id)) {
  646. $data = $this->find('first', array('conditions' => array($this->primaryKey => $id), 'contain' => array()));
  647. }
  648. if (empty($id) || empty($data) || empty($data[$this->alias][$sortField])) {
  649. return array();
  650. } else {
  651. $field = $data[$this->alias][$sortField];
  652. }
  653. $findOptions = array('recursive' => -1);
  654. if (isset($qryOptions['recursive'])) {
  655. $findOptions['recursive'] = $qryOptions['recursive'];
  656. }
  657. if (isset($qryOptions['contain'])) {
  658. $findOptions['contain'] = $qryOptions['contain'];
  659. }
  660. $findOptions['fields'] = array($this->alias . '.' . $this->primaryKey, $this->alias . '.' . $displayField);
  661. $findOptions['conditions'][$this->alias . '.' . $this->primaryKey . ' !='] = $id;
  662. // //TODO: take out
  663. if (!empty($options['filter']) && $options['filter'] == REQUEST_STATUS_FILTER_OPEN) {
  664. $findOptions['conditions'][$this->alias . '.status <'] = REQUEST_STATUS_DECLINED;
  665. } elseif (!empty($options['filter']) && $options['filter'] == REQUEST_STATUS_FILTER_CLOSED) {
  666. $findOptions['conditions'][$this->alias . '.status >='] = REQUEST_STATUS_DECLINED;
  667. }
  668. $return = array();
  669. if (!empty($qryOptions['conditions'])) {
  670. $findOptions['conditions'] = Hash::merge($findOptions['conditions'], $qryOptions['conditions']);
  671. }
  672. $options = $findOptions;
  673. $options['conditions'] = Hash::merge($options['conditions'], array($this->alias . '.' . $sortField . ' ' . $sortDirSymb[1] => $field));
  674. $options['order'] = array($this->alias . '.' . $sortField . '' => $sortDirWord[1]);
  675. $this->id = $id;
  676. $return['prev'] = $this->find('first', $options);
  677. $options = $findOptions;
  678. $options['conditions'] = Hash::merge($options['conditions'], array($this->alias . '.' . $sortField . ' ' . $sortDirSymb[0] => $field));
  679. $options['order'] = array($this->alias . '.' . $sortField . '' => $sortDirWord[0]); // ??? why 0 instead of 1
  680. $this->id = $id;
  681. $return['next'] = $this->find('first', $options);
  682. return $return;
  683. }
  684. /**
  685. * Delete all records using an atomic query similar to updateAll().
  686. * Note: Does not need manual sanitizing/escaping, though.
  687. *
  688. * Does not do any callbacks
  689. *
  690. * @param mixed $conditions Conditions to match, true for all records
  691. * @return boolean Success
  692. */
  693. public function deleteAllRaw($conditions = true) {
  694. return $this->getDataSource()->delete($this, $conditions);
  695. }
  696. /**
  697. * Overwrite invalidate to allow last => true
  698. *
  699. * @param string $field The name of the field to invalidate
  700. * @param mixed $value Name of validation rule that was not failed, or validation message to
  701. * be returned. If no validation key is provided, defaults to true.
  702. * @param boolean $last If this should be the last validation check for this validation run
  703. * @return void
  704. */
  705. public function invalidate($field, $value = true, $last = false) {
  706. parent::invalidate($field, $value);
  707. if (!$last) {
  708. return;
  709. }
  710. $this->validator()->remove($field);
  711. }
  712. /**
  713. * Validates a primary or foreign key depending on the current schema data for this field
  714. * recognizes uuid (char36) and aiid (int10 unsigned) - not yet mixed (varchar36)
  715. * more useful than using numeric or notEmpty which are type specific
  716. *
  717. * @param array $data
  718. * @param array $options
  719. * - allowEmpty
  720. * @return boolean Success
  721. */
  722. public function validateKey($data = array(), $options = array()) {
  723. $keys = array_keys($data);
  724. $key = array_shift($keys);
  725. $value = array_shift($data);
  726. $schema = $this->schema($key);
  727. if (!$schema) {
  728. return true;
  729. }
  730. $defaults = array(
  731. 'allowEmpty' => false,
  732. );
  733. $options = array_merge($defaults, $options);
  734. if ($schema['type'] !== 'integer') {
  735. if ($options['allowEmpty'] && $value === '') {
  736. return true;
  737. }
  738. return Validation::uuid($value);
  739. }
  740. if ($options['allowEmpty'] && $value === 0) {
  741. return true;
  742. }
  743. return is_numeric($value) && (int)$value == $value && $value > 0;
  744. }
  745. /**
  746. * Checks if the passed enum value is valid
  747. *
  748. * @return boolean Success
  749. */
  750. public function validateEnum(array $data, $enum = null, $additionalKeys = array()) {
  751. $keys = array_keys($data);
  752. $valueKey = array_shift($keys);
  753. $value = $data[$valueKey];
  754. $keys = array();
  755. if ($enum === true) {
  756. $enum = $valueKey;
  757. }
  758. if ($enum !== null) {
  759. if (!method_exists($this, $enum)) {
  760. trigger_error('Enum method \'' . $enum . '()\' not exists', E_USER_ERROR);
  761. return false;
  762. }
  763. //TODO: make static
  764. $keys = $this->{$enum}();
  765. }
  766. $keys = array_merge($additionalKeys, array_keys($keys));
  767. if (!empty($keys) && in_array($value, $keys)) {
  768. return true;
  769. }
  770. return false;
  771. }
  772. /**
  773. * Checks if the content of 2 fields are equal
  774. * Does not check on empty fields! Return TRUE even if both are empty (secure against empty in another rule)!
  775. *
  776. * @return boolean Success
  777. */
  778. public function validateIdentical($data = array(), $compareWith = null, $options = array()) {
  779. if (is_array($data)) {
  780. $value = array_shift($data);
  781. } else {
  782. $value = $data;
  783. }
  784. $compareValue = $this->data[$this->alias][$compareWith];
  785. $matching = array('string' => 'string', 'int' => 'integer', 'float' => 'float', 'bool' => 'boolean');
  786. if (!empty($options['cast']) && array_key_exists($options['cast'], $matching)) {
  787. // cast values to string/int/float/bool if desired
  788. settype($compareValue, $matching[$options['cast']]);
  789. settype($value, $matching[$options['cast']]);
  790. }
  791. return ($compareValue === $value);
  792. }
  793. /**
  794. * Checks a record, if it is unique - depending on other fields in this table (transfered as array)
  795. * example in model: 'rule' => array ('validateUnique', array('belongs_to_table_id','some_id','user_id')),
  796. * if all keys (of the array transferred) match a record, return false, otherwise true
  797. *
  798. * @param array $fields Other fields to depend on
  799. * TODO: add possibity of deep nested validation (User -> Comment -> CommentCategory: UNIQUE comment_id, Comment.user_id)
  800. * @param array $options
  801. * - requireDependentFields Require all dependent fields for the validation rule to return true
  802. * @return boolean Success
  803. */
  804. public function validateUnique($data, $fields = array(), $options = array()) {
  805. $id = (!empty($this->data[$this->alias][$this->primaryKey]) ? $this->data[$this->alias][$this->primaryKey] : 0);
  806. if (!$id && $this->id) {
  807. $id = $this->id;
  808. }
  809. foreach ($data as $key => $value) {
  810. $fieldName = $key;
  811. $fieldValue = $value;
  812. break;
  813. }
  814. $conditions = array(
  815. $this->alias . '.' . $fieldName => $fieldValue,
  816. $this->alias . '.id !=' => $id);
  817. // careful, if fields is not manually filled, the options will be the second param!!! big problem...
  818. $fields = (array)$fields;
  819. if (!array_key_exists('allowEmpty', $fields)) {
  820. foreach ($fields as $dependingField) {
  821. if (isset($this->data[$this->alias][$dependingField])) { // add ONLY if some content is transfered (check on that first!)
  822. $conditions[$this->alias . '.' . $dependingField] = $this->data[$this->alias][$dependingField];
  823. } elseif (isset($this->data['Validation'][$dependingField])) { // add ONLY if some content is transfered (check on that first!
  824. $conditions[$this->alias . '.' . $dependingField] = $this->data['Validation'][$dependingField];
  825. } elseif (!empty($id)) {
  826. // manual query! (only possible on edit)
  827. $res = $this->find('first', array('fields' => array($this->alias . '.' . $dependingField), 'conditions' => array($this->alias . '.id' => $id)));
  828. if (!empty($res)) {
  829. $conditions[$this->alias . '.' . $dependingField] = $res[$this->alias][$dependingField];
  830. }
  831. } else {
  832. if (!empty($options['requireDependentFields'])) {
  833. trigger_error('Required field ' . $dependingField . ' for validateUnique validation not present');
  834. return false;
  835. }
  836. return true;
  837. }
  838. }
  839. }
  840. $this->recursive = -1;
  841. if (count($conditions) > 2) {
  842. $this->recursive = 0;
  843. }
  844. $options = array('fields' => array($this->alias . '.' . $this->primaryKey), 'conditions' => $conditions);
  845. $res = $this->find('first', $options);
  846. return empty($res);
  847. }
  848. /**
  849. * Alterative for validating unique fields.
  850. *
  851. * @param array $data
  852. * @param array $options
  853. * - scope (array of other fields as scope - isUnique dependent on other fields of the table)
  854. * - batch (defaults to true, remembers previous values in order to validate batch imports)
  855. * example in model: 'rule' => array ('validateUniqueExt', array('scope'=>array('belongs_to_table_id','some_id','user_id'))),
  856. * http://groups.google.com/group/cake-php/browse_thread/thread/880ee963456739ec
  857. * //TODO: test!!!
  858. * @return boolean Success
  859. * @deprecated in favor of validateUnique?
  860. */
  861. public function validateUniqueExt($data, $options = array()) {
  862. foreach ($data as $key => $value) {
  863. $fieldName = $key;
  864. $fieldValue = $value;
  865. }
  866. $defaults = array('batch' => true, 'scope' => array());
  867. $options = array_merge($defaults, $options);
  868. // for batch
  869. if ($options['batch'] !== false && !empty($this->batchRecords)) {
  870. if (array_key_exists($value, $this->batchRecords[$fieldName])) {
  871. return $options['scope'] === $this->batchRecords[$fieldName][$value];
  872. }
  873. }
  874. // continue with validation
  875. if (!$this->validateUnique($data, $options['scope'])) {
  876. return false;
  877. }
  878. // for batch
  879. if ($options['batch'] !== false) {
  880. if (!isset($this->batchRecords)) {
  881. $this->batchRecords = array();
  882. }
  883. $this->batchRecords[$fieldName][$value] = $scope;
  884. }
  885. return true;
  886. }
  887. /**
  888. * Checks if a url is valid AND accessable (returns false otherwise)
  889. *
  890. * @param array/string $data: full url(!) starting with http://...
  891. * @options array
  892. * - allowEmpty TRUE/FALSE (TRUE: if empty => return TRUE)
  893. * - required TRUE/FALSE (TRUE: overrides allowEmpty)
  894. * - autoComplete (default: TRUE)
  895. * - deep (default: TRUE)
  896. * @return boolean Success
  897. */
  898. public function validateUrl($data, $options = array()) {
  899. if (is_array($data)) {
  900. foreach ($data as $key => $url) {
  901. break;
  902. }
  903. } else {
  904. $url = $data;
  905. }
  906. if (empty($url)) {
  907. if (!empty($options['allowEmpty']) && empty($options['required'])) {
  908. return true;
  909. }
  910. return false;
  911. }
  912. if (!isset($options['autoComplete']) || $options['autoComplete'] !== false) {
  913. $url = $this->_autoCompleteUrl($url);
  914. if (isset($key)) {
  915. $this->data[$this->alias][$key] = $url;
  916. }
  917. }
  918. if (!isset($options['strict']) || $options['strict'] !== false) {
  919. $options['strict'] = true;
  920. }
  921. // validation
  922. if (!Validation::url($url, $options['strict']) && env('REMOTE_ADDR') && env('REMOTE_ADDR') !== '127.0.0.1') {
  923. return false;
  924. }
  925. // same domain?
  926. if (!empty($options['sameDomain']) && env('HTTP_HOST')) {
  927. $is = parse_url($url, PHP_URL_HOST);
  928. $expected = env('HTTP_HOST');
  929. if (mb_strtolower($is) !== mb_strtolower($expected)) {
  930. return false;
  931. }
  932. }
  933. if (isset($options['deep']) && $options['deep'] === false) {
  934. return true;
  935. }
  936. return $this->_validUrl($url);
  937. }
  938. /**
  939. * Prepend protocol if missing
  940. *
  941. * @param string $url
  942. * @return string Url
  943. */
  944. protected function _autoCompleteUrl($url) {
  945. if (mb_strpos($url, '/') === 0) {
  946. $url = Router::url($url, true);
  947. } elseif (mb_strpos($url, '://') === false && mb_strpos($url, 'www.') === 0) {
  948. $url = 'http://' . $url;
  949. }
  950. return $url;
  951. }
  952. /**
  953. * Checks if a url is valid
  954. *
  955. * @param string url
  956. * @return boolean Success
  957. */
  958. protected function _validUrl($url) {
  959. $headers = Utility::getHeaderFromUrl($url);
  960. if ($headers === false) {
  961. return false;
  962. }
  963. $headers = implode("\n", $headers);
  964. $protocol = mb_strpos($url, 'https://') === 0 ? 'HTTP' : 'HTTP';
  965. if (!preg_match('#^' . $protocol . '/.*?\s+[(200|301|302)]+\s#i', $headers)) {
  966. return false;
  967. }
  968. if (preg_match('#^' . $protocol . '/.*?\s+[(404|999)]+\s#i', $headers)) {
  969. return false;
  970. }
  971. return true;
  972. }
  973. /**
  974. * Validation of DateTime Fields (both Date and Time together)
  975. *
  976. * @param options
  977. * - dateFormat (defaults to 'ymd')
  978. * - allowEmpty
  979. * - after/before (fieldName to validate against)
  980. * - min/max (defaults to >= 1 - at least 1 minute apart)
  981. * @return boolean Success
  982. */
  983. public function validateDateTime($data, $options = array()) {
  984. $format = !empty($options['dateFormat']) ? $options['dateFormat'] : 'ymd';
  985. if (is_array($data)) {
  986. $value = array_shift($data);
  987. } else {
  988. $value = $data;
  989. }
  990. $dateTime = explode(' ', trim($value), 2);
  991. $date = $dateTime[0];
  992. $time = (!empty($dateTime[1]) ? $dateTime[1] : '');
  993. if (!empty($options['allowEmpty']) && (empty($date) && empty($time) || $date == DEFAULT_DATE && $time == DEFAULT_TIME || $date == DEFAULT_DATE && empty($time))) {
  994. return true;
  995. }
  996. /*
  997. if ($this->validateDate($date, $options) && $this->validateTime($time, $options)) {
  998. return true;
  999. }
  1000. */
  1001. if (Validation::date($date, $format) && Validation::time($time)) {
  1002. // after/before?
  1003. $minutes = isset($options['min']) ? $options['min'] : 1;
  1004. if (!empty($options['after']) && isset($this->data[$this->alias][$options['after']])) {
  1005. if (strtotime($this->data[$this->alias][$options['after']]) > strtotime($value) - $minutes) {
  1006. return false;
  1007. }
  1008. }
  1009. if (!empty($options['before']) && isset($this->data[$this->alias][$options['before']])) {
  1010. if (strtotime($this->data[$this->alias][$options['before']]) < strtotime($value) + $minutes) {
  1011. return false;
  1012. }
  1013. }
  1014. return true;
  1015. }
  1016. return false;
  1017. }
  1018. /**
  1019. * Validation of Date fields (as the core one is buggy!!!)
  1020. *
  1021. * @param options
  1022. * - dateFormat (defaults to 'ymd')
  1023. * - allowEmpty
  1024. * - after/before (fieldName to validate against)
  1025. * - min (defaults to 0 - equal is OK too)
  1026. * @return boolean Success
  1027. */
  1028. public function validateDate($data, $options = array()) {
  1029. $format = !empty($options['format']) ? $options['format'] : 'ymd';
  1030. if (is_array($data)) {
  1031. $value = array_shift($data);
  1032. } else {
  1033. $value = $data;
  1034. }
  1035. $dateTime = explode(' ', trim($value), 2);
  1036. $date = $dateTime[0];
  1037. if (!empty($options['allowEmpty']) && (empty($date) || $date == DEFAULT_DATE)) {
  1038. return true;
  1039. }
  1040. if (Validation::date($date, $format)) {
  1041. // after/before?
  1042. $days = !empty($options['min']) ? $options['min'] : 0;
  1043. if (!empty($options['after']) && isset($this->data[$this->alias][$options['after']])) {
  1044. if ($this->data[$this->alias][$options['after']] > date(FORMAT_DB_DATE, strtotime($date) - $days * DAY)) {
  1045. return false;
  1046. }
  1047. }
  1048. if (!empty($options['before']) && isset($this->data[$this->alias][$options['before']])) {
  1049. if ($this->data[$this->alias][$options['before']] < date(FORMAT_DB_DATE, strtotime($date) + $days * DAY)) {
  1050. return false;
  1051. }
  1052. }
  1053. return true;
  1054. }
  1055. return false;
  1056. }
  1057. /**
  1058. * Validation of Time fields
  1059. *
  1060. * @param array $options
  1061. * - timeFormat (defaults to 'hms')
  1062. * - allowEmpty
  1063. * - after/before (fieldName to validate against)
  1064. * - min/max (defaults to >= 1 - at least 1 minute apart)
  1065. * @return boolean Success
  1066. */
  1067. public function validateTime($data, $options = array()) {
  1068. if (is_array($data)) {
  1069. $value = array_shift($data);
  1070. } else {
  1071. $value = $data;
  1072. }
  1073. $dateTime = explode(' ', trim($value), 2);
  1074. $value = array_pop($dateTime);
  1075. if (Validation::time($value)) {
  1076. // after/before?
  1077. if (!empty($options['after']) && isset($this->data[$this->alias][$options['after']])) {
  1078. if ($this->data[$this->alias][$options['after']] >= $value) {
  1079. return false;
  1080. }
  1081. }
  1082. if (!empty($options['before']) && isset($this->data[$this->alias][$options['before']])) {
  1083. if ($this->data[$this->alias][$options['before']] <= $value) {
  1084. return false;
  1085. }
  1086. }
  1087. return true;
  1088. }
  1089. return false;
  1090. }
  1091. /**
  1092. * Validation of Date Fields (>= minDate && <= maxDate)
  1093. *
  1094. * @param options
  1095. * - min/max (TODO!!)
  1096. */
  1097. public function validateDateRange($data, $options = array()) {
  1098. }
  1099. /**
  1100. * Validation of Time Fields (>= minTime && <= maxTime)
  1101. *
  1102. * @param options
  1103. * - min/max (TODO!!)
  1104. */
  1105. public function validateTimeRange($data, $options = array()) {
  1106. }
  1107. /**
  1108. * Model validation rule for email addresses
  1109. *
  1110. * @return boolean Success
  1111. */
  1112. public function validateUndisposable($data, $proceed = false) {
  1113. $email = array_shift($data);
  1114. if (empty($email)) {
  1115. return true;
  1116. }
  1117. return $this->isUndisposableEmail($email, false, $proceed);
  1118. }
  1119. /**
  1120. * NOW: can be set to work offline only (if server is down etc)
  1121. * Checks if a email is not from a garbage hoster
  1122. *
  1123. * @param string email (necessary)
  1124. * @return boolean true if valid, else false
  1125. */
  1126. public function isUndisposableEmail($email, $onlineMode = false, $proceed = false) {
  1127. if (!isset($this->UndisposableEmail)) {
  1128. App::import('Vendor', 'undisposable/undisposable');
  1129. $this->UndisposableEmail = new UndisposableEmail();
  1130. }
  1131. if (!$onlineMode) {
  1132. // crashed with white screen of death otherwise... (if foreign page is 404)
  1133. $this->UndisposableEmail->useOnlineList(false);
  1134. }
  1135. if (!class_exists('Validation')) {
  1136. App::uses('Validation', 'Utility');
  1137. }
  1138. if (!Validation::email($email)) {
  1139. return false;
  1140. }
  1141. if ($this->UndisposableEmail->isUndisposableEmail($email) === false) {
  1142. // trigger log
  1143. $this->log('Disposable Email detected: ' . h($email) . ' (IP ' . env('REMOTE_ADDR') . ')', 'undisposable');
  1144. if ($proceed === true) {
  1145. return true;
  1146. }
  1147. return false;
  1148. }
  1149. return true;
  1150. }
  1151. /**
  1152. * Is blocked email?
  1153. * //TODO: move outside of MyModel?
  1154. *
  1155. * @return boolean ifNotBlacklisted
  1156. */
  1157. public function validateNotBlocked($params) {
  1158. $email = array_shift($params);
  1159. if (!isset($this->Blacklist)) {
  1160. $this->Blacklist = ClassRegistry::init('Tools.Blacklist');
  1161. }
  1162. if ($this->Blacklist->isBlacklisted(Blacklist::TYPE_EMAIL, $email)) {
  1163. return false;
  1164. }
  1165. return true;
  1166. }
  1167. /**
  1168. * Set + guaranteeFields!
  1169. * Extends the core set function (only using data!!!)
  1170. *
  1171. * @param mixed $data
  1172. * @param mixed $data2 (optional)
  1173. * @param array $requiredFields Required fields
  1174. * @param array $fieldList Whitelist / Allowed fields
  1175. * @return array
  1176. */
  1177. public function set($data, $data2 = null, $requiredFields = array(), $fieldList = array()) {
  1178. if (!empty($requiredFields)) {
  1179. $data = $this->guaranteeFields($requiredFields, $data);
  1180. }
  1181. if (!empty($fieldList)) {
  1182. $data = $this->whitelist($fieldList, $data);
  1183. }
  1184. return parent::set($data, $data2);
  1185. }
  1186. /**
  1187. * @param array $fieldList
  1188. * @param array $data (optional)
  1189. * @return array
  1190. */
  1191. public function whitelist(array $fieldList, $data = null) {
  1192. $model = $this->alias;
  1193. if ($data === null) {
  1194. $data =& $this->data;
  1195. }
  1196. if (empty($data[$model])) {
  1197. return array();
  1198. }
  1199. foreach ($data[$model] as $key => $val) {
  1200. if (!in_array($key, $fieldList)) {
  1201. unset($data[$model][$key]);
  1202. }
  1203. }
  1204. return $data;
  1205. }
  1206. /**
  1207. * Instead of whitelisting this will remove all blacklisted keys.
  1208. *
  1209. * @param array $blacklist
  1210. * - array: fields to blacklist
  1211. * - boolean TRUE: removes all foreign_keys (_id)
  1212. * note: one-dimensional
  1213. * @return array
  1214. */
  1215. public function blacklist($blacklist, $data = null) {
  1216. $model = $this->alias;
  1217. if ($data === null) {
  1218. $data =& $this->data;
  1219. }
  1220. if (empty($data[$model])) {
  1221. return array();
  1222. }
  1223. if ($blacklist === true) {
  1224. foreach ($data[$model] as $key => $value) {
  1225. if (substr($key, -3, 3) === '_id') {
  1226. unset($data[$model][$key]);
  1227. }
  1228. }
  1229. return;
  1230. }
  1231. foreach ($blacklist as $key) {
  1232. if (isset($data[$model][$key])) {
  1233. unset($data[$model][$key]);
  1234. }
  1235. }
  1236. return $data;
  1237. }
  1238. /**
  1239. * Generate a whitelist, based on the current schema and a passed blacklist.
  1240. *
  1241. * @param array $blacklist
  1242. * @return array
  1243. */
  1244. public function generateWhitelistFromBlacklist(array $blacklist) {
  1245. return array_diff(array_keys($this->schema()), $blacklist);
  1246. }
  1247. /**
  1248. * Make sure required fields exists - in order to properly validate them
  1249. *
  1250. * @param array: field1, field2 - or field1, Model2.field1 etc
  1251. * @param array: data (optional, otherwise the array with the required fields will be returned)
  1252. * @return array
  1253. */
  1254. public function guaranteeFields($requiredFields, $data = null) {
  1255. $guaranteedFields = array();
  1256. foreach ($requiredFields as $column) {
  1257. if (strpos($column, '.') !== false) {
  1258. list($model, $column) = explode('.', $column, 2);
  1259. } else {
  1260. $model = $this->alias;
  1261. }
  1262. $guaranteedFields[$model][$column] = ''; # now field exists in any case!
  1263. }
  1264. if ($data === null) {
  1265. return $guaranteedFields;
  1266. }
  1267. if (!empty($guaranteedFields)) {
  1268. $data = Hash::merge($guaranteedFields, $data);
  1269. }
  1270. return $data;
  1271. }
  1272. /**
  1273. * Make certain fields a requirement for the form to validate
  1274. * (they must only be present - can still be empty, though!)
  1275. *
  1276. * @param array $fieldList
  1277. * @param boolean $allowEmpty (or NULL to not touch already set elements)
  1278. * @return void
  1279. */
  1280. public function requireFields($requiredFields, $allowEmpty = null) {
  1281. if ($allowEmpty === null) {
  1282. $setAllowEmpty = true;
  1283. } else {
  1284. $setAllowEmpty = $allowEmpty;
  1285. }
  1286. foreach ($requiredFields as $column) {
  1287. if (strpos($column, '.') !== false) {
  1288. list($model, $column) = explode('.', $column, 2);
  1289. } else {
  1290. $model = $this->alias;
  1291. }
  1292. if ($model !== $this->alias) {
  1293. continue;
  1294. }
  1295. if (empty($this->validate[$column])) {
  1296. $this->validate[$column]['notEmpty'] = array('rule' => 'notEmpty', 'required' => true, 'allowEmpty' => $setAllowEmpty, 'message' => 'valErrMandatoryField');
  1297. } else {
  1298. $keys = array_keys($this->validate[$column]);
  1299. if (!in_array('rule', $keys)) {
  1300. $key = array_shift($keys);
  1301. $this->validate[$column][$key]['required'] = true;
  1302. if (!isset($this->validate[$column][$key]['allowEmpty'])) {
  1303. $this->validate[$column][$key]['allowEmpty'] = $setAllowEmpty;
  1304. }
  1305. } else {
  1306. $keys['required'] = true;
  1307. if (!isset($keys['allowEmpty'])) {
  1308. $keys['allowEmpty'] = $setAllowEmpty;
  1309. }
  1310. $this->validate[$column] = $keys;
  1311. }
  1312. }
  1313. }
  1314. }
  1315. /**
  1316. * Shortcut method to find a specific entry via primary key.
  1317. *
  1318. * Either provide the id directly:
  1319. *
  1320. * $record = $this->Model->get($id);
  1321. *
  1322. * Or use
  1323. *
  1324. * $this->Model->id = $id;
  1325. * $record = $this->Model->get();
  1326. *
  1327. * @param mixed $id
  1328. * @param array $options Options for find(). Used to be fields array/string.
  1329. * @param array $contain Deprecated - use
  1330. * @return mixed
  1331. */
  1332. public function get($id = null, $options = array(), $contain = array()) {
  1333. if (is_array($id)) {
  1334. $column = $id[0];
  1335. $value = $id[1];
  1336. } else {
  1337. $column = $this->primaryKey;
  1338. $value = $id;
  1339. if ($value === null) {
  1340. $value = $this->id;
  1341. }
  1342. }
  1343. if (!$value) {
  1344. return array();
  1345. }
  1346. // BC
  1347. $fields = null;
  1348. if (is_string($options)) {
  1349. $fields = $options;
  1350. $options = array();
  1351. }
  1352. if (!empty($options) && !array_key_exists('fields', $options) && !array_key_exists('contain', $options)) {
  1353. $fields = $options;
  1354. $options = array();
  1355. }
  1356. if ($fields === '*') {
  1357. $fields = $this->alias . '.*';
  1358. } elseif (!empty($fields)) {
  1359. foreach ($fields as $row => $field) {
  1360. if (strpos($field, '.') !== false) {
  1361. continue;
  1362. }
  1363. $fields[$row] = $this->alias . '.' . $field;
  1364. }
  1365. }
  1366. $options = array(
  1367. 'conditions' => array($this->alias . '.' . $column => $value),
  1368. ) + $options;
  1369. // BC
  1370. if (!empty($fields)) {
  1371. $options['fields'] = $fields;
  1372. }
  1373. if (!empty($contain)) {
  1374. $options['contain'] = $contain;
  1375. }
  1376. return $this->find('first', $options);
  1377. }
  1378. /**
  1379. * Get all related entries that have been used so far
  1380. *
  1381. * @param string $modelName The related model
  1382. * @param string $groupField Field to group by
  1383. * @param string $type Find type
  1384. * @param array $options
  1385. * @return array
  1386. */
  1387. public function getRelatedInUse($modelName, $groupField = null, $type = 'all', $options = array()) {
  1388. if ($groupField === null) {
  1389. $groupField = $this->belongsTo[$modelName]['foreignKey'];
  1390. }
  1391. $defaults = array(
  1392. 'contain' => array($modelName),
  1393. 'group' => $groupField,
  1394. 'order' => $this->$modelName->order ? $this->$modelName->order : array($modelName . '.' . $this->$modelName->displayField => 'ASC'),
  1395. );
  1396. if ($type === 'list') {
  1397. $defaults['fields'] = array($modelName . '.' . $this->$modelName->primaryKey, $modelName . '.' . $this->$modelName->displayField);
  1398. }
  1399. $options += $defaults;
  1400. return $this->find($type, $options);
  1401. }
  1402. /**
  1403. * Get all fields that have been used so far
  1404. *
  1405. * @param string $groupField Field to group by
  1406. * @param string $type Find type
  1407. * @param array $options
  1408. * @return array
  1409. */
  1410. public function getFieldInUse($groupField, $type = 'all', $options = array()) {
  1411. $defaults = array(
  1412. 'group' => $groupField,
  1413. 'order' => array($this->alias . '.' . $this->displayField => 'ASC'),
  1414. );
  1415. if ($type === 'list') {
  1416. $defaults['fields'] = array($this->alias . '.' . $this->primaryKey, $this->alias . '.' . $this->displayField);
  1417. }
  1418. $options += $defaults;
  1419. return $this->find($type, $options);
  1420. }
  1421. /**
  1422. * Update a row with certain fields (dont use "Model" as super-key)
  1423. *
  1424. * @param integer $id
  1425. * @param array $data
  1426. * @return boolean|array Success
  1427. */
  1428. public function update($id, $data, $validate = false) {
  1429. $this->id = $id;
  1430. return $this->save($data, $validate, array_keys($data));
  1431. }
  1432. /**
  1433. * Toggles Field (Important/Deleted/Primary etc)
  1434. *
  1435. * @param STRING fieldName
  1436. * @param integer id (cleaned!)
  1437. * @return ARRAY record: [Model][values],...
  1438. */
  1439. public function toggleField($fieldName, $id) {
  1440. $record = $this->get($id, array($this->primaryKey, $fieldName));
  1441. if (!empty($record) && !empty($fieldName) && $this->hasField($fieldName)) {
  1442. $record[$this->alias][$fieldName] = ($record[$this->alias][$fieldName] == 1 ? 0 : 1);
  1443. $this->id = $id;
  1444. $this->saveField($fieldName, $record[$this->alias][$fieldName]);
  1445. }
  1446. return $record;
  1447. }
  1448. /**
  1449. * Truncate TABLE (already validated, that table exists)
  1450. *
  1451. * @param string table [default:FALSE = current model table]
  1452. * @return boolean Success
  1453. */
  1454. public function truncate($table = null) {
  1455. if (empty($table)) {
  1456. $table = $this->table;
  1457. }
  1458. $db = ConnectionManager::getDataSource($this->useDbConfig);
  1459. return $db->truncate($table);
  1460. }
  1461. /**
  1462. * Recursive Dropdown Lists
  1463. * NEEDS tree behavior, NEEDS lft, rght, parent_id (!)
  1464. * //FIXME
  1465. */
  1466. public function recursiveSelect($conditions = array(), $attachTree = false, $spacer = '-- ') {
  1467. if ($attachTree) {
  1468. $this->Behaviors->load('Tree');
  1469. }
  1470. $data = $this->generateTreeList($conditions, null, null, $spacer);
  1471. return $data;
  1472. }
  1473. /**
  1474. * From http://othy.wordpress.com/2006/06/03/generatenestedlist/
  1475. * NEEDS parent_id
  1476. * //TODO refactor for 1.2
  1477. *
  1478. * @deprecated use generateTreeList instead
  1479. */
  1480. public function generateNestedList($conditions = null, $indent = '--') {
  1481. $cats = $this->find('threaded', array('conditions' => $conditions, 'fields' => array(
  1482. $this->alias . '.' . $this->primaryKey,
  1483. $this->alias . '.' . $this->displayField,
  1484. $this->alias . '.parent_id')));
  1485. return $this->_generateNestedList($cats, $indent);
  1486. }
  1487. /**
  1488. * From http://othy.wordpress.com/2006/06/03/generatenestedlist/
  1489. *
  1490. * @deprecated use generateTreeList instead
  1491. */
  1492. public function _generateNestedList($cats, $indent = '--', $level = 0) {
  1493. static $list = array();
  1494. $c = count($cats);
  1495. for ($i = 0; $i < $c; $i++) {
  1496. $list[$cats[$i][$this->alias][$this->primaryKey]] = str_repeat($indent, $level) . $cats[$i][$this->alias][$this->displayField];
  1497. if (!empty($cats[$i]['children'])) {
  1498. $this->_generateNestedList($cats[$i]['children'], $indent, $level + 1);
  1499. }
  1500. }
  1501. return $list;
  1502. }
  1503. }