Context Navigation

source: extensions/AMetaData/JpegMetaData/Readers/XmpReader.class.php @ 6729

Last change on this file since 6729 was 6729, checked in by grum, 14 years ago

feature:1777

Weight of the metadata database can becomes very heavy

Property svn:executable set to *

File size: 23.1 KB

Line
1	<?php
2	/*
3	* --:: JPEG MetaDatas ::-------------------------------------------------------
4	*
5	* Author : Grum
6	* email : grum at piwigo.org
7	* website : http://photos.grum.fr
8	*
9	* << May the Little SpaceFrog be with you ! >>
10	*
11	*
12	* +-----------------------------------------------------------------------+
13	* \| JpegMetaData - a PHP based Jpeg Metadata manager \|
14	* +-----------------------------------------------------------------------+
15	* \| Copyright(C) 2010 Grum - http://www.grum.fr \|
16	* +-----------------------------------------------------------------------+
17	* \| This program is free software; you can redistribute it and/or modify \|
18	* \| it under the terms of the GNU General Public License as published by \|
19	* \| the Free Software Foundation \|
20	* \| \|
21	* \| This program is distributed in the hope that it will be useful, but \|
22	* \| WITHOUT ANY WARRANTY; without even the implied warranty of \|
23	* \| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU \|
24	* \| General Public License for more details. \|
25	* \| \|
26	* \| You should have received a copy of the GNU General Public License \|
27	* \| along with this program; if not, write to the Free Software \|
28	* \| Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, \|
29	* \| USA. \|
30	* +-----------------------------------------------------------------------+
31	*
32	*
33	* -----------------------------------------------------------------------------
34	*
35	* The XmpReader class is the dedicated class to read XMP from the APP1 segment
36	*
37	* -----------------------------------------------------------------------------
38	*
39	* .. Notes ..
40	*
41	* The XmpReader class is derived from the GenericReader class.
42	*
43	* ======> See GenericReader.class.php to know more about common methods <======
44	*
45	* -----------------------------------------------------------------------------
46	*/
47
48	require_once(JPEG_METADATA_DIR."Common/Data.class.php");
49	require_once(JPEG_METADATA_DIR."Common/XmlData.class.php");
50	require_once(JPEG_METADATA_DIR."Readers/GenericReader.class.php");
51	require_once(JPEG_METADATA_DIR."TagDefinitions/XmpTags.class.php");
52
53	class XmpReader extends GenericReader
54	{
55	protected $schema = Schemas::XMP;
56
57	private $xmlData = NULL;
58
59	private $xmpTag2Exif = NULL;
60
61	/**
62	* The constructor needs, like the ancestor, the datas to be parsed
63	*
64	* @param String $data
65	*/
66	function __construct($data)
67	{
68	/**
69	* XML data are given from an APP1 segement.
70	*
71	* The XMP header ends with a \x00 char, so XML data can be extracted
72	* after the \x00 char
73	*
74	*/
75	$this->data=explode("\x00", $data);
76	if(count($this->data)>1)
77	{
78	$this->data=$this->data[1];
79	}
80	else
81	{
82	$this->data="";
83	}
84
85	parent::__construct($this->data);
86
87	$this->xmpTag2Exif = new XmpTag2Exif("", 0, 0);
88
89	$this->xmlData = new XmlData($this->data->readASCII(-1,0));
90	$this->tagDef = new XmpTags();
91
92	$this->loadTags();
93
94	$this->isValid = $this->xmlData->isValid();
95	$this->isLoaded = $this->xmlData->isLoaded();
96
97	}
98
99	function __destruct()
100	{
101	unset($this->xmlData);
102	unset($this->xmpTag2Exif);
103	parent::__destruct();
104	}
105
106	public function toString()
107	{
108	$returned=$this->data->readASCII(-1,0);
109	return($returned);
110	}
111
112	/**
113	* This function load tags from the xml tree
114	*/
115	private function loadTags()
116	{
117	if($this->xmlData->hasNodes())
118	{
119	$this->processNode($this->xmlData->getFirstNode());
120	}
121	}
122
123	/**
124	* this function analyze the node properties
125	* - attributes are converted in Tag through a call to the addTag function
126	* - childs are processed by a specific call to the processChildNode
127	* function
128	* - next node is processed by a recursive call
129	*
130	* @param XmlNode $node
131	*/
132	private function processNode($node)
133	{
134	if(!is_null($node))
135	{
136	$node->setName($this->processNodeName($node->getName()));
137
138	foreach($node->getAttributes() as $key => $val)
139	{
140	$val['name']=$this->processNodeName($val['name']);
141	$this->addTag($val['name'], $val['value']);
142	}
143
144	if(!is_null($node->getValue()))
145	{
146	$this->addTag($node->getName(), $node->getValue());
147	}
148
149	if($node->hasChilds())
150	{
151	$this->processChildNode($node);
152	}
153
154	$this->processNode($node->getNextNode());
155	}
156	}
157
158
159	/**
160	* 'xap' schemas have to be interpreted as a 'xmp' schemas
161	* so, this function rename all 'xap' nodes in 'xmp' nodes
162	*
163	* @param String $nodeName
164	*/
165	private function processNodeName($nodeName)
166	{
167	$name=preg_replace(Array("/^(xap:)/", "/^(xapMM:)/"), Array("xmp:", "xmpMM:"), $nodeName);
168
169	return($name);
170	}
171
172
173	/**
174	* childs node are 'seq', 'alt' or 'bag' type and needs a specific
175	* interpretation
176	*
177	* this function process this kind of data, and add it in the Tag entries
178	*
179	* if child node is not a special a specific node, process it as a normal
180	* node
181	*
182	* @param XmlNode $node
183	*/
184	private function processChildNode($node)
185	{
186	switch($node->getName())
187	{
188	/*
189	* child must be 'rdf:Seq', 'rdf:Bag' or 'rdf:Alt'
190	*/
191	case "dc:contributor" : // bag
192	case "dc:creator" : // seq
193	case "dc:date" : // seq
194	case "dc:description" : // alt
195	case "dc:language" : // bag
196	case "dc:publisher" : // bag
197	case "dc:relation" : // bag
198	case "dc:rights" : // alt
199	case "dc:subject" : // bag
200	case "dc:title" : // alt
201	case "dc:Type" : // bag
202	case "xmp:Advisory" : // bag
203	case "xmp:Identifier" : // bag
204	case "xmp:Thumbnails" : // alt
205	case "xmpRights:Owner" : // bag
206	case "xmpRights:UsageTerms" : // alt
207	case "xmpMM:History" : // seq
208	case "xmpMM:Versions" : // seq
209	case "xmpBJ:JobRef" : // bag
210	case "xmpTPg:Fonts" : // bag
211	case "xmpTPg:Colorants" : // seq
212	case "xmpTPg:PlateNames" : // seq
213	case "photoshop:SupplementalCategories" : // bag
214	case "crs:ToneCurve" : // seq
215	case "tiff:BitsPerSample" : // seq
216	case "tiff:YCbCrSubSampling" : // seq
217	case "tiff:TransferFunction" : // seq
218	case "tiff:WhitePoint" : // seq
219	case "tiff:PrimaryChromaticities" : // seq
220	case "tiff:YCbCrCoefficients" : // seq
221	case "tiff:ReferenceBlackWhite" : // seq
222	case "tiff:ImageDescription" : // alt
223	case "tiff:Copyright" : // alt
224	case "exif:ComponentsConfiguration" : // seq
225	case "exif:UserComment" : // alt
226	case "exif:ISOSpeedRatings" : // seq
227	case "exif:SubjectArea" : // seq
228	case "exif:SubjectLocation" : // seq
229	case "Iptc4xmpCore:Scene": //bag
230	case "Iptc4xmpCore:SubjectCode": //bag
231	$child=$node->getFirstChild();
232	switch($child->getName())
233	{
234	case "rdf:Seq":
235	$type="seq";
236	break;
237	case "rdf:Bag":
238	$type="bag";
239	break;
240	case "rdf:Alt":
241	$type="alt";
242	break;
243	default:
244	$type="n/a";
245	break;
246	}
247	if($type=="seq" or $type=="bag" or $type="alt")
248	{
249	$value=Array('type' => $type, 'values' => Array());
250	$childNode=$child->getFirstChild();
251	while(!is_null($childNode))
252	{
253	if($childNode->getName() == "rdf:li")
254	{
255	if($type=="alt")
256	{
257	$attributes=$childNode->getAttributes();
258	if(count($attributes)>0)
259	{
260	$attributes=$attributes[0];
261	}
262	else
263	{
264	$attributes="n/a";
265	}
266	$value['values'][]=Array('type' => $attributes, 'value' => $childNode->getValue());
267	}
268	else
269	{
270	$value['values'][]=$childNode->getValue();
271	}
272	}
273	$childNode=$childNode->getNextNode();
274	}
275	$this->addTag($node->getName(), $value);
276	}
277	unset($child);
278	break;
279	default:
280	$this->processNode($node->getFirstChild());
281	break;
282	}
283	}
284
285	/**
286	* add a Tag to the entries.
287	* name and value are needed, the function made the rest (interpret the
288	* value into a 'human readable' value)
289	*
290	* @param String $name : the name of the tag
291	* @param $value : can be of any type
292	*/
293	private function addTag($name, $value)
294	{
295	$tag=new Tag($name, $value, $name);
296
297	if($this->tagDef->tagIdExists($name))
298	{
299	$tagProperties=$this->tagDef->getTagById($name);
300
301	$tag->setKnown(true);
302	$tag->setImplemented($tagProperties['implemented']);
303	$tag->setTranslatable($tagProperties['translatable']);
304	$tag->setSchema($this->schema);
305
306	if(array_key_exists('name', $tagProperties))
307	{
308	$tag->setName($tagProperties['name']);
309	}
310
311	/*
312	* if there is values defined for the tag, analyze it
313	*/
314	if(array_key_exists('tagValues', $tagProperties))
315	{
316	if(array_key_exists($value, $tagProperties['tagValues']))
317	{
318	$tag->setLabel($tagProperties['tagValues'][$value]);
319	}
320	else
321	{
322	$tag->setLabel("[unknown value '".$value."']");
323	}
324	}
325	else
326	{
327	/*
328	* there is no values defined for the tag, analyzing it with dedicated
329	* function
330	*/
331	if(array_key_exists('exifTag', $tagProperties))
332	{
333	$tag->setLabel($this->xmp2Exif($name, $tagProperties['exifTag'], $value));
334	}
335	else
336	{
337	$tag->setLabel($this->processSpecialTag($name, $value));
338	}
339
340	}
341	unset($tagProperties);
342	}
343
344	$this->entries[]=$tag;
345	unset($tag);
346	}
347
348	/**
349	* this function do the interpretation of specials tags
350	*
351	* the function return the interpreted value for the tag
352	*
353	* @param $name : the name of the tag
354	* @param $value : 'raw' value to be interpreted
355	*/
356	private function processSpecialTag($name, $value)
357	{
358	/*
359	* Note : exif & tiff values are not processed in this function
360	*/
361	switch($name)
362	{
363	case "x:xmptk":
364	case "aux:Lens":
365	case "aux:Firmware":
366	case "aux:SerialNumber":
367	case "dc:coverage":
368	case "dc:format":
369	case "dc:identifier":
370	case "dc:relation":
371	case "dc:source":
372	case "dc:title":
373	case "dc:CreatorTool":
374	case "xmp:BaseURL":
375	case "xmp:CreatorTool":
376	case "xmp:Label":
377	case "xmp:Nickname":
378	case "xmp:Rating:":
379	case "xmpRights:Certificate":
380	case "xmpRights:Marked":
381	case "xmpRights:UsageTerms":
382	case "xmpRights:WebStatement":
383	case "xmpMM:DocumentID":
384	case "xmpMM:InstanceID":
385	case "xmpMM:Manager":
386	case "xmpMM:ManageTo":
387	case "xmpMM:ManageUI":
388	case "xmpMM:ManagerVariant":
389	case "xmpMM:RenditionParams":
390	case "xmpMM:VersionID":
391	case "xmpMM:LastURL":
392	case "photoshop:AuthorsPosition":
393	case "photoshop:CaptionWriter":
394	case "photoshop:Category":
395	case "photoshop:City":
396	case "photoshop:Country":
397	case "photoshop:Credit":
398	case "photoshop:Headline":
399	case "photoshop:Instructions":
400	case "photoshop:Source":
401	case "photoshop:State":
402	case "photoshop:TransmissionReference":
403	case "photoshop:ICCProfile":
404	case "crs:AutoBrightness":
405	case "crs:AutoContrast":
406	case "crs:AutoExposure":
407	case "crs:AutoShadows":
408	case "crs:BlueHue":
409	case "crs:BlueSaturation":
410	case "crs:Brightness":
411	case "crs:CameraProfile":
412	case "crs:ChromaticAberrationB":
413	case "crs:ChromaticAberrationR":
414	case "crs:ColorNoiseReduction":
415	case "crs:Contrast":
416	case "crs:CropTop":
417	case "crs:CropLeft":
418	case "crs:CropBottom":
419	case "crs:CropRight":
420	case "crs:CropAngle":
421	case "crs:CropWidth":
422	case "crs:CropHeight":
423	case "crs:Exposure":
424	case "crs:GreenHue":
425	case "crs:GreenSaturation":
426	case "crs:HasCrop":
427	case "crs:HasSettings":
428	case "crs:LuminanceSmoothing":
429	case "crs:RawFileName":
430	case "crs:RedHue":
431	case "crs:RedSaturation":
432	case "crs:Saturation":
433	case "crs:Shadows":
434	case "crs:ShadowTint":
435	case "crs:Sharpness":
436	case "crs:Temperature":
437	case "crs:Tint":
438	case "crs:Version":
439	case "crs:VignetteAmount":
440	case "crs:VignetteMidpoint":
441	case "Iptc4xmpCore:CountryCode":
442	case "Iptc4xmpCore:Location":
443	case "Iptc4xmpCore:CiEmailWork":
444	case "Iptc4xmpCore:CiUrlWork":
445	case "Iptc4xmpCore:CiTelWork":
446	case "Iptc4xmpCore:CiAdrExtadr":
447	case "Iptc4xmpCore:CiAdrPcode":
448	case "Iptc4xmpCore:CiAdrCity":
449	case "Iptc4xmpCore:CiAdrCtry":
450	$returned=$value;
451	break;
452	case "Iptc4xmpCore:IntellectualGenre":
453	$returned=explode(":", $value);
454	break;
455	case "exif:GPSLatitude":
456	case "exif:GPSLongitude":
457	case "exif:GPSDestLatitude":
458	case "exif:GPSDestLongitude":
459	$returned=Array('coord' => "", 'card'=>"");
460	preg_match_all('/(\d{1,3}),(\d{1,2})(?:\.(\d*)){0,1}(N\|S\|E\|W)/', $value, $result);
461	$returned['coord']=$result[1][0]."° ".$result[2][0]."' ";
462	if(trim($result[3][0])!="")
463	{
464	$returned['coord'].= round(("0.".$result[3][0])*60,2)."\"";
465	}
466	switch($result[4][0])
467	{
468	case "N":
469	$returned['card']="North";
470	break;
471	case "S":
472	$returned['card']="South";
473	break;
474	case "E":
475	$returned['card']="East";
476	break;
477	case "W":
478	$returned['card']="West";
479	break;
480	}
481	$type=ByteType::UNDEFINED;
482	break;
483	case "xmp:CreateDate":
484	case "xmp:ModifyDate":
485	case "xmp:MetadataDate":
486	case "tiff:DateTime":
487	case "photoshop:DateCreated":
488	case "Iptc4xmpCore:DateCreated":
489	$returned=ConvertData::toDateTime($value);
490	break;
491	case "dc:contributor" : // bag
492	case "dc:creator" : // seq
493	case "dc:date" : // seq
494	case "dc:description" : // alt
495	case "dc:language" : // bag
496	case "dc:publisher" : // bag
497	case "dc:relation" : // bag
498	case "dc:rights" : // alt
499	case "dc:subject" : // bag
500	case "dc:title" : // alt
501	case "dc:Type" : // bag
502	case "xmp:Advisory" : // bag
503	case "xmp:Identifier" : // bag
504	case "xmp:Thumbnails" : // alt
505	case "xmpRights:Owner" : // bag
506	case "xmpRights:UsageTerms" : // alt
507	case "xmpMM:History" : // seq
508	case "xmpMM:Versions" : // seq
509	case "xmpBJ:JobRef" : // bag
510	case "xmpTPg:Fonts" : // bag
511	case "xmpTPg:Colorants" : // seq
512	case "xmpTPg:PlateNames" : // seq
513	case "photoshop:SupplementalCategories" : // bag
514	case "crs:ToneCurve" : // seq
515	case "tiff:BitsPerSample" : // seq
516	case "tiff:YCbCrSubSampling" : // seq
517	case "tiff:TransferFunction" : // seq
518	case "tiff:WhitePoint" : // seq
519	case "tiff:PrimaryChromaticities" : // seq
520	case "tiff:YCbCrCoefficients" : // seq
521	case "tiff:ReferenceBlackWhite" : // seq
522	case "tiff:ImageDescription" : // alt
523	case "tiff:Copyright" : // alt
524	case "exif:ComponentsConfiguration" : // seq
525	case "exif:UserComment" : // alt
526	case "exif:ISOSpeedRatings" : // seq
527	case "exif:SubjectArea" : // seq
528	case "exif:SubjectLocation" : // seq
529	$returned=$value;
530	break;
531	case "Iptc4xmpCore:Scene": //bag
532	$tag=$this->tagDef->getTagById('Iptc4xmpCore:Scene');
533	$returned=$value;
534	foreach($returned['values'] as $key=>$val)
535	{
536	if(array_key_exists($val, $tag['tagValues.special']))
537	$returned['values'][$key]=$tag['tagValues.special'][$val];
538	}
539	unset($tag);
540	break;
541	case "Iptc4xmpCore:SubjectCode": //bag
542	$returned=$value;
543	foreach($returned['values'] as $key=>$val)
544	{
545	$tmp=explode(":", $val);
546
547	$returned['values'][$key]=Array();
548
549	if(count($tmp)>=1)
550	$returned['values'][$key]['IPR']=$tmp[0];
551
552	if(count($tmp)>=2)
553	$returned['values'][$key]['subjectCode']=$tmp[1];
554
555	if(count($tmp)>=3)
556	$returned['values'][$key]['subjectName']=$tmp[2];
557
558	if(count($tmp)>=4)
559	$returned['values'][$key]['subjectMatterName']=$tmp[3];
560
561	if(count($tmp)>=5)
562	$returned['values'][$key]['subjectDetailName']=$tmp[4];
563
564	unset($tmp);
565	}
566	break;
567	default:
568	$returned="Not yet implemented; $name";
569	break;
570	}
571	return($returned);
572	}
573
574	/**
575	* this function convert the value from XMP 'exif' or XMP 'tiff' data by
576	* using an instance of a XmpTag2Exif object (using exif tag object allows
577	* not coding the same things twice)
578	*/
579	private function xmp2Exif($tagName, $exifTag, $xmpValue)
580	{
581	switch($tagName)
582	{
583	/* integers */
584	case "tiff:ImageWidth":
585	case "tiff:ImageLength":
586	case "tiff:PhotometricInterpretation":
587	case "tiff:Orientation":
588	case "tiff:SamplesPerPixel":
589	case "tiff:PlanarConfiguration":
590	case "tiff:YCbCrSubSampling":
591	case "tiff:YCbCrPositioning":
592	case "tiff:ResolutionUnit":
593	case "exif:ColorSpace":
594	case "exif:PixelXDimension":
595	case "exif:PixelYDimension":
596	case "exif:MeteringMode":
597	case "exif:LightSource":
598	case "exif:FlashEnergy":
599	case "exif:FocalPlaneResolutionUnit":
600	case "exif:SensingMethod":
601	case "exif:FileSource":
602	case "exif:SceneType":
603	case "exif:CustomRendered":
604	case "exif:ExposureMode":
605	case "exif:Balance":
606	case "exif:FocalLengthIn35mmFilm":
607	case "exif:SceneCaptureType":
608	case "exif:GainControl":
609	case "exif:Contrast":
610	case "exif:Saturation":
611	case "exif:Sharpness":
612	case "exif:SubjectDistanceRange":
613	case "exif:GPSAltitudeRef":
614	case "exif:GPSDifferential":
615	$returned=(int)$xmpValue;
616	$type=ByteType::ULONG;
617	break;
618	/* specials */
619	case "tiff:BitsPerSample":
620	case "tiff:Compression":
621	case "tiff:TransferFunction":
622	case "tiff:WhitePoint":
623	case "tiff:PrimaryChromaticities":
624	case "tiff:YCbCrCoefficients":
625	case "tiff:ReferenceBlackWhite":
626	case "exif:ComponentsConfiguration":
627	case "exif:ExposureProgram":
628	case "exif:ISOSpeedRatings":
629	case "exif:OECF":
630	case "exif:Flash":
631	case "exif:SubjectArea":
632	case "exif:SpatialFrequencyResponse":
633	case "exif:SubjectLocation":
634	case "exif:CFAPattern":
635	case "exif:DeviceSettingDescription":
636	$returned=$xmpValue;
637	$type=ByteType::UNDEFINED;
638	break;
639	/* rational */
640	case "tiff:XResolution":
641	case "tiff:YResolution":
642	case "exif:CompressedBitsPerPixel":
643	case "exif:ExposureTime":
644	case "exif:FNumber":
645	case "exif:ShutterSpeedValue":
646	case "exif:ApertureValue":
647	case "exif:BrightnessValue":
648	case "exif:ExposureBiasValue":
649	case "exif:MaxApertureValue":
650	case "exif:SubjectDistance":
651	case "exif:FocalLength":
652	case "exif:FocalPlaneXResolution":
653	case "exif:FocalPlaneYResolution":
654	case "exif:ExposureIndex":
655	case "exif:DigitalZoomRatio":
656	case "exif:GPSAltitude":
657	case "exif:GPSDOP":
658	case "exif:GPSSpeed":
659	case "exif:GPSTrack":
660	case "exif:GPSImgDirection":
661	case "exif:GPSDestBearing":
662	case "exif:GPSDestDistance":
663	$computed=explode("/", $xmpValue);
664	$returned=Array((int)$computed[0], (int)$computed[1]);
665	$type=ByteType::URATIONAL;
666	unset($computed);
667	break;
668	/* dates & texts */
669	case "tiff:DateTime":
670	case "tiff:ImageDescription":
671	case "tiff:Make":
672	case "tiff:Model":
673	case "tiff:Software":
674	case "tiff:Artist":
675	case "tiff:Copyright":
676	case "exif:ExifVersion":
677	case "exif:FlashpixVersion":
678	case "exif:UserComment":
679	case "exif:RelatedSoundFile":
680	case "exif:DateTimeOriginal":
681	case "exif:DateTimeDigitized":
682	case "exif:SpectralSensitivity":
683	case "exif:ImageUniqueID":
684	case "exif:GPSVersionID":
685	case "exif:GPSTimeStamp":
686	case "exif:GPSSatellites":
687	case "exif:GPSStatus":
688	case "exif:GPSMeasureMode":
689	case "exif:GPSSpeedRef":
690	case "exif:GPSTrackRef":
691	case "exif:GPSImgDirectionRef":
692	case "exif:GPSMapDatum":
693	case "exif:GPSDestBearingRef":
694	case "exif:GPSDestDistanceRef":
695	case "exif:GPSProcessingMethod":
696	case "exif:GPSAreaInformation":
697	$returned=$xmpValue;
698	$type=ByteType::ASCII;
699	break;
700	default:
701	$returned="Unknown tag: $tagName => $xmpValue";
702	break;
703	}
704	if(is_array($returned))
705	{
706	if(array_key_exists('type', $returned))
707	{
708	if($returned['type']=='alt')
709	{
710	}
711	else
712	{
713	foreach($returned['values'] as $key => $val)
714	{
715	$returned['values'][$key]['value']=$this->xmpTag2Exif->convert($exifTag, $val['value'], $type);
716	}
717	}
718	}
719	else
720	{
721	return($this->xmpTag2Exif->convert($exifTag, $returned, $type));
722	}
723	}
724	return($returned);
725	}
726
727	}
728
729	/**
730	* The XmpTag2Exif is derived from the IfdReader class
731	*
732	* This function provides the public function 'convert', allowing to convert
733	* 'exif' datas in 'human readable' values
734	*
735	*/
736	class XmpTag2Exif extends IfdReader
737	{
738	public function convert($exifTag, $value, $type)
739	{
740	return($this->processSpecialTag($exifTag, $value, $type));
741	}
742	}
743
744	?>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: