1 /***************************************************************************/
5 /* Embedded resource forks accessor (body). */
7 /* Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010 by */
8 /* Masatake YAMATO and Redhat K.K. */
10 /* FT_Raccess_Get_HeaderInfo() and raccess_guess_darwin_hfsplus() are */
11 /* derived from ftobjs.c. */
13 /* This file is part of the FreeType project, and may only be used, */
14 /* modified, and distributed under the terms of the FreeType project */
15 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
16 /* this file you indicate that you have read the license and */
17 /* understand and accept it fully. */
19 /***************************************************************************/
21 /***************************************************************************/
22 /* Development of the code in this file is support of */
23 /* Information-technology Promotion Agency, Japan. */
24 /***************************************************************************/
28 #include FT_INTERNAL_DEBUG_H
29 #include FT_INTERNAL_STREAM_H
30 #include FT_INTERNAL_RFORK_H
34 #define FT_COMPONENT trace_raccess
37 /*************************************************************************/
38 /*************************************************************************/
39 /*************************************************************************/
42 /**** Resource fork directory access ****/
45 /*************************************************************************/
46 /*************************************************************************/
47 /*************************************************************************/
49 FT_BASE_DEF( FT_Error )
50 FT_Raccess_Get_HeaderInfo( FT_Library library,
57 unsigned char head[16], head2[16];
58 FT_Long map_pos, rdata_len;
59 int allzeros, allmatch, i;
65 error = FT_Stream_Seek( stream, rfork_offset );
69 error = FT_Stream_Read( stream, (FT_Byte *)head, 16 );
73 *rdata_pos = rfork_offset + ( ( head[0] << 24 ) |
77 map_pos = rfork_offset + ( ( head[4] << 24 ) |
81 rdata_len = ( head[ 8] << 24 ) |
86 /* map_len = head[12] .. head[15] */
88 if ( *rdata_pos + rdata_len != map_pos || map_pos == rfork_offset )
89 return FT_Err_Unknown_File_Format;
91 error = FT_Stream_Seek( stream, map_pos );
95 head2[15] = (FT_Byte)( head[15] + 1 ); /* make it be different */
97 error = FT_Stream_Read( stream, (FT_Byte*)head2, 16 );
103 for ( i = 0; i < 16; ++i )
107 if ( head2[i] != head[i] )
110 if ( !allzeros && !allmatch )
111 return FT_Err_Unknown_File_Format;
113 /* If we have reached this point then it is probably a mac resource */
114 /* file. Now, does it contain any interesting resources? */
115 /* Skip handle to next resource map, the file resource number, and */
117 (void)FT_STREAM_SKIP( 4 /* skip handle to next resource map */
118 + 2 /* skip file resource number */
119 + 2 ); /* skip attributes */
121 if ( FT_READ_USHORT( type_list ) )
123 if ( type_list == -1 )
124 return FT_Err_Unknown_File_Format;
126 error = FT_Stream_Seek( stream, map_pos + type_list );
130 *map_offset = map_pos + type_list;
136 ft_raccess_sort_ref_by_id( FT_RFork_Ref* a,
139 if ( a->res_id < b->res_id )
141 else if ( a->res_id > b->res_id )
148 FT_BASE_DEF( FT_Error )
149 FT_Raccess_Get_DataOffsets( FT_Library library,
158 int i, j, cnt, subcnt;
159 FT_Long tag_internal, rpos;
160 FT_Memory memory = library->memory;
162 FT_Long *offsets_internal = NULL;
163 FT_RFork_Ref *ref = NULL;
166 error = FT_Stream_Seek( stream, map_offset );
170 if ( FT_READ_USHORT( cnt ) )
174 for ( i = 0; i < cnt; ++i )
176 if ( FT_READ_LONG( tag_internal ) ||
177 FT_READ_USHORT( subcnt ) ||
178 FT_READ_USHORT( rpos ) )
181 FT_TRACE2(( "Resource tags: %c%c%c%c\n",
182 (char)( 0xff & ( tag_internal >> 24 ) ),
183 (char)( 0xff & ( tag_internal >> 16 ) ),
184 (char)( 0xff & ( tag_internal >> 8 ) ),
185 (char)( 0xff & ( tag_internal >> 0 ) ) ));
187 if ( tag_internal == tag )
192 error = FT_Stream_Seek( stream, rpos );
196 if ( FT_NEW_ARRAY( ref, *count ) )
199 for ( j = 0; j < *count; ++j )
201 if ( FT_READ_USHORT( ref[j].res_id ) )
203 if ( FT_STREAM_SKIP( 2 ) ) /* resource name */
205 if ( FT_READ_LONG( temp ) )
207 if ( FT_STREAM_SKIP( 4 ) ) /* mbz */
210 ref[j].offset = temp & 0xFFFFFFL;
213 ft_qsort( ref, *count, sizeof ( FT_RFork_Ref ),
214 ( int(*)(const void*, const void*) )
215 ft_raccess_sort_ref_by_id );
217 if ( FT_NEW_ARRAY( offsets_internal, *count ) )
220 /* XXX: duplicated reference ID,
221 * gap between reference IDs are acceptable?
222 * further investigation on Apple implementation is needed.
224 for ( j = 0; j < *count; ++j )
225 offsets_internal[j] = rdata_pos + ref[j].offset;
227 *offsets = offsets_internal;
236 return FT_Err_Cannot_Open_Resource;
240 #ifdef FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK
242 /*************************************************************************/
243 /*************************************************************************/
244 /*************************************************************************/
247 /**** Guessing functions ****/
249 /**** When you add a new guessing function, ****/
250 /**** update FT_RACCESS_N_RULES in ftrfork.h. ****/
252 /*************************************************************************/
253 /*************************************************************************/
254 /*************************************************************************/
257 raccess_guess_apple_double( FT_Library library,
259 char *base_file_name,
260 char **result_file_name,
261 FT_Long *result_offset );
264 raccess_guess_apple_single( FT_Library library,
266 char *base_file_name,
267 char **result_file_name,
268 FT_Long *result_offset );
271 raccess_guess_darwin_ufs_export( FT_Library library,
273 char *base_file_name,
274 char **result_file_name,
275 FT_Long *result_offset );
278 raccess_guess_darwin_newvfs( FT_Library library,
280 char *base_file_name,
281 char **result_file_name,
282 FT_Long *result_offset );
285 raccess_guess_darwin_hfsplus( FT_Library library,
287 char *base_file_name,
288 char **result_file_name,
289 FT_Long *result_offset );
292 raccess_guess_vfat( FT_Library library,
294 char *base_file_name,
295 char **result_file_name,
296 FT_Long *result_offset );
299 raccess_guess_linux_cap( FT_Library library,
301 char *base_file_name,
302 char **result_file_name,
303 FT_Long *result_offset );
306 raccess_guess_linux_double( FT_Library library,
308 char *base_file_name,
309 char **result_file_name,
310 FT_Long *result_offset );
313 raccess_guess_linux_netatalk( FT_Library library,
315 char *base_file_name,
316 char **result_file_name,
317 FT_Long *result_offset );
320 CONST_FT_RFORK_RULE_ARRAY_BEGIN(ft_raccess_guess_table,
321 ft_raccess_guess_rec)
322 CONST_FT_RFORK_RULE_ARRAY_ENTRY(apple_double, apple_double)
323 CONST_FT_RFORK_RULE_ARRAY_ENTRY(apple_single, apple_single)
324 CONST_FT_RFORK_RULE_ARRAY_ENTRY(darwin_ufs_export, darwin_ufs_export)
325 CONST_FT_RFORK_RULE_ARRAY_ENTRY(darwin_newvfs, darwin_newvfs)
326 CONST_FT_RFORK_RULE_ARRAY_ENTRY(darwin_hfsplus, darwin_hfsplus)
327 CONST_FT_RFORK_RULE_ARRAY_ENTRY(vfat, vfat)
328 CONST_FT_RFORK_RULE_ARRAY_ENTRY(linux_cap, linux_cap)
329 CONST_FT_RFORK_RULE_ARRAY_ENTRY(linux_double, linux_double)
330 CONST_FT_RFORK_RULE_ARRAY_ENTRY(linux_netatalk, linux_netatalk)
331 CONST_FT_RFORK_RULE_ARRAY_END
334 /*************************************************************************/
336 /**** Helper functions ****/
338 /*************************************************************************/
341 raccess_guess_apple_generic( FT_Library library,
343 char *base_file_name,
345 FT_Long *result_offset );
348 raccess_guess_linux_double_from_file_name( FT_Library library,
350 FT_Long *result_offset );
353 raccess_make_file_name( FT_Memory memory,
354 const char *original_name,
355 const char *insertion );
358 FT_Raccess_Guess( FT_Library library,
368 for ( i = 0; i < FT_RACCESS_N_RULES; i++ )
371 if ( NULL != stream )
372 errors[i] = FT_Stream_Seek( stream, 0 );
374 errors[i] = FT_Err_Ok;
379 errors[i] = (FT_RACCESS_GUESS_TABLE_GET[i].func)( library,
391 raccess_get_rule_type_from_rule_index( FT_Library library,
394 FT_UNUSED( library );
396 if ( rule_index >= FT_RACCESS_N_RULES )
397 return FT_RFork_Rule_invalid;
399 return FT_RACCESS_GUESS_TABLE_GET[rule_index].type;
404 * For this function, refer ftbase.h.
406 FT_LOCAL_DEF( FT_Bool )
407 ft_raccess_rule_by_darwin_vfs( FT_Library library,
410 switch( raccess_get_rule_type_from_rule_index( library, rule_index ) )
412 case FT_RFork_Rule_darwin_newvfs:
413 case FT_RFork_Rule_darwin_hfsplus:
424 raccess_guess_apple_double( FT_Library library,
426 char *base_file_name,
427 char **result_file_name,
428 FT_Long *result_offset )
430 FT_Int32 magic = ( 0x00 << 24 ) |
436 *result_file_name = NULL;
437 if ( NULL == stream )
438 return FT_Err_Cannot_Open_Stream;
440 return raccess_guess_apple_generic( library, stream, base_file_name,
441 magic, result_offset );
446 raccess_guess_apple_single( FT_Library library,
448 char *base_file_name,
449 char **result_file_name,
450 FT_Long *result_offset )
452 FT_Int32 magic = ( 0x00 << 24 ) |
458 *result_file_name = NULL;
459 if ( NULL == stream )
460 return FT_Err_Cannot_Open_Stream;
462 return raccess_guess_apple_generic( library, stream, base_file_name,
463 magic, result_offset );
468 raccess_guess_darwin_ufs_export( FT_Library library,
470 char *base_file_name,
471 char **result_file_name,
472 FT_Long *result_offset )
481 memory = library->memory;
482 newpath = raccess_make_file_name( memory, base_file_name, "._" );
484 return FT_Err_Out_Of_Memory;
486 error = raccess_guess_linux_double_from_file_name( library, newpath,
489 *result_file_name = newpath;
498 raccess_guess_darwin_hfsplus( FT_Library library,
500 char *base_file_name,
501 char **result_file_name,
502 FT_Long *result_offset )
505 Only meaningful on systems with hfs+ drivers (or Macs).
508 char* newpath = NULL;
510 FT_Long base_file_len = ft_strlen( base_file_name );
515 memory = library->memory;
517 if ( base_file_len + 6 > FT_INT_MAX )
518 return FT_Err_Array_Too_Large;
520 if ( FT_ALLOC( newpath, base_file_len + 6 ) )
523 FT_MEM_COPY( newpath, base_file_name, base_file_len );
524 FT_MEM_COPY( newpath + base_file_len, "/rsrc", 6 );
526 *result_file_name = newpath;
534 raccess_guess_darwin_newvfs( FT_Library library,
536 char *base_file_name,
537 char **result_file_name,
538 FT_Long *result_offset )
541 Only meaningful on systems with Mac OS X (> 10.1).
544 char* newpath = NULL;
546 FT_Long base_file_len = ft_strlen( base_file_name );
551 memory = library->memory;
553 if ( base_file_len + 18 > FT_INT_MAX )
554 return FT_Err_Array_Too_Large;
556 if ( FT_ALLOC( newpath, base_file_len + 18 ) )
559 FT_MEM_COPY( newpath, base_file_name, base_file_len );
560 FT_MEM_COPY( newpath + base_file_len, "/..namedfork/rsrc", 18 );
562 *result_file_name = newpath;
570 raccess_guess_vfat( FT_Library library,
572 char *base_file_name,
573 char **result_file_name,
574 FT_Long *result_offset )
582 memory = library->memory;
584 newpath = raccess_make_file_name( memory, base_file_name,
587 return FT_Err_Out_Of_Memory;
589 *result_file_name = newpath;
597 raccess_guess_linux_cap( FT_Library library,
599 char *base_file_name,
600 char **result_file_name,
601 FT_Long *result_offset )
609 memory = library->memory;
611 newpath = raccess_make_file_name( memory, base_file_name, ".resource/" );
613 return FT_Err_Out_Of_Memory;
615 *result_file_name = newpath;
623 raccess_guess_linux_double( FT_Library library,
625 char *base_file_name,
626 char **result_file_name,
627 FT_Long *result_offset )
636 memory = library->memory;
638 newpath = raccess_make_file_name( memory, base_file_name, "%" );
640 return FT_Err_Out_Of_Memory;
642 error = raccess_guess_linux_double_from_file_name( library, newpath,
645 *result_file_name = newpath;
654 raccess_guess_linux_netatalk( FT_Library library,
656 char *base_file_name,
657 char **result_file_name,
658 FT_Long *result_offset )
667 memory = library->memory;
669 newpath = raccess_make_file_name( memory, base_file_name,
672 return FT_Err_Out_Of_Memory;
674 error = raccess_guess_linux_double_from_file_name( library, newpath,
677 *result_file_name = newpath;
686 raccess_guess_apple_generic( FT_Library library,
688 char *base_file_name,
690 FT_Long *result_offset )
692 FT_Int32 magic_from_stream;
694 FT_Int32 version_number = 0;
695 FT_UShort n_of_entries;
698 FT_UInt32 entry_id, entry_offset, entry_length = 0;
700 const FT_UInt32 resource_fork_entry_id = 0x2;
702 FT_UNUSED( library );
703 FT_UNUSED( base_file_name );
704 FT_UNUSED( version_number );
705 FT_UNUSED( entry_length );
708 if ( FT_READ_LONG( magic_from_stream ) )
710 if ( magic_from_stream != magic )
711 return FT_Err_Unknown_File_Format;
713 if ( FT_READ_LONG( version_number ) )
717 error = FT_Stream_Skip( stream, 16 );
721 if ( FT_READ_USHORT( n_of_entries ) )
723 if ( n_of_entries == 0 )
724 return FT_Err_Unknown_File_Format;
726 for ( i = 0; i < n_of_entries; i++ )
728 if ( FT_READ_LONG( entry_id ) )
730 if ( entry_id == resource_fork_entry_id )
732 if ( FT_READ_LONG( entry_offset ) ||
733 FT_READ_LONG( entry_length ) )
735 *result_offset = entry_offset;
741 error = FT_Stream_Skip( stream, 4 + 4 ); /* offset + length */
747 return FT_Err_Unknown_File_Format;
752 raccess_guess_linux_double_from_file_name( FT_Library library,
754 FT_Long *result_offset )
762 args2.flags = FT_OPEN_PATHNAME;
763 args2.pathname = file_name;
764 error = FT_Stream_New( library, &args2, &stream2 );
768 error = raccess_guess_apple_double( library, stream2, file_name,
769 &nouse, result_offset );
771 FT_Stream_Free( stream2, 0 );
778 raccess_make_file_name( FT_Memory memory,
779 const char *original_name,
780 const char *insertion )
782 char* new_name = NULL;
786 FT_Error error = FT_Err_Ok;
791 new_length = ft_strlen( original_name ) + ft_strlen( insertion );
792 if ( FT_ALLOC( new_name, new_length + 1 ) )
795 tmp = ft_strrchr( original_name, '/' );
798 ft_strncpy( new_name, original_name, tmp - original_name + 1 );
799 new_name[tmp - original_name + 1] = '\0';
804 slash = original_name;
808 ft_strcat( new_name, insertion );
809 ft_strcat( new_name, slash );
815 #else /* !FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK */
818 /*************************************************************************/
819 /* Dummy function; just sets errors */
820 /*************************************************************************/
823 FT_Raccess_Guess( FT_Library library,
832 FT_UNUSED( library );
834 FT_UNUSED( base_name );
837 for ( i = 0; i < FT_RACCESS_N_RULES; i++ )
841 errors[i] = FT_Err_Unimplemented_Feature;
846 #endif /* !FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK */