Merged changes in the trunk up to revision 43585.
[blender.git] / source / blender / blenlib / intern / bpath.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Campbell barton, Alex Fraser
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenlib/intern/bpath.c
29  *  \ingroup bli
30  */
31
32 /* TODO,
33  * currently there are some cases we dont support.
34  * - passing output paths to the visitor?, like render out.
35  * - passing sequence strips with many images.
36  * - passing directory paths - visitors dont know which path is a dir or a file.
37  * */
38
39 #include <sys/stat.h>
40
41 #include <string.h>
42 #include <assert.h>
43
44 /* path/file handeling stuff */
45 #ifndef WIN32
46   #include <dirent.h>
47   #include <unistd.h>
48 #else
49   #include <io.h>
50   #include "BLI_winstuff.h"
51 #endif
52
53 #include "MEM_guardedalloc.h"
54
55 #include "DNA_brush_types.h"
56 #include "DNA_image_types.h"
57 #include "DNA_mesh_types.h"
58 #include "DNA_modifier_types.h"
59 #include "DNA_movieclip_types.h"
60 #include "DNA_object_fluidsim.h"
61 #include "DNA_object_force.h"
62 #include "DNA_object_types.h"
63 #include "DNA_particle_types.h"
64 #include "DNA_sequence_types.h"
65 #include "DNA_sound_types.h"
66 #include "DNA_text_types.h"
67 #include "DNA_texture_types.h"
68 #include "DNA_vfont_types.h"
69 #include "DNA_scene_types.h"
70 #include "DNA_smoke_types.h"
71 #include "DNA_freestyle_types.h"
72
73 #include "BLI_blenlib.h"
74 #include "BLI_bpath.h"
75 #include "BLI_utildefines.h"
76
77 #include "BKE_library.h"
78 #include "BKE_main.h"
79 #include "BKE_report.h"
80 #include "BKE_sequencer.h"
81 #include "BKE_utildefines.h"
82 #include "BKE_image.h" /* so we can check the image's type */
83
84 static int checkMissingFiles_visit_cb(void *userdata, char *UNUSED(path_dst), const char *path_src)
85 {
86         ReportList *reports= (ReportList *)userdata;
87
88         if (!BLI_exists(path_src)) {
89                 BKE_reportf(reports, RPT_WARNING, "Path Not Found \"%s\"", path_src);
90         }
91
92         return FALSE;
93 }
94
95 /* high level function */
96 void checkMissingFiles(Main *bmain, ReportList *reports)
97 {
98         bpath_traverse_main(bmain, checkMissingFiles_visit_cb, BPATH_TRAVERSE_ABS, reports);
99 }
100
101 typedef struct BPathRemap_Data
102 {
103         const char *basedir;
104         ReportList *reports;
105
106         int count_tot;
107         int count_changed;
108         int count_failed;
109 } BPathRemap_Data;
110
111 static int makeFilesRelative_visit_cb(void *userdata, char *path_dst, const char *path_src)
112 {
113         BPathRemap_Data *data= (BPathRemap_Data *)userdata;
114
115         data->count_tot++;
116
117         if(strncmp(path_src, "//", 2)==0) {
118                 return FALSE; /* already relative */
119         }
120         else {
121                 strcpy(path_dst, path_src);
122                 BLI_path_rel(path_dst, data->basedir);
123                 if (strncmp(path_dst, "//", 2)==0) {
124                         data->count_changed++;
125                 }
126                 else {
127                         BKE_reportf(data->reports, RPT_WARNING, "Path cant be made relative \"%s\"", path_src);
128                         data->count_failed++;
129                 }
130                 return TRUE;
131         }
132 }
133
134 void makeFilesRelative(Main *bmain, const char *basedir, ReportList *reports)
135 {
136         BPathRemap_Data data= {NULL};
137
138         if(basedir[0] == '\0') {
139                 printf("%s: basedir='', this is a bug\n", __func__);
140                 return;
141         }
142
143         data.basedir= basedir;
144         data.reports= reports;
145
146         bpath_traverse_main(bmain, makeFilesRelative_visit_cb, 0, (void *)&data);
147
148         BKE_reportf(reports, data.count_failed ? RPT_WARNING : RPT_INFO,
149                     "Total files %d|Changed %d|Failed %d",
150                     data.count_tot, data.count_changed, data.count_failed);
151 }
152
153 static int makeFilesAbsolute_visit_cb(void *userdata, char *path_dst, const char *path_src)
154 {
155         BPathRemap_Data *data= (BPathRemap_Data *)userdata;
156
157         data->count_tot++;
158
159         if(strncmp(path_src, "//", 2)!=0) {
160                 return FALSE; /* already absolute */
161         }
162         else {
163                 strcpy(path_dst, path_src);
164                 BLI_path_abs(path_dst, data->basedir);
165                 if (strncmp(path_dst, "//", 2)!=0) {
166                         data->count_changed++;
167                 }
168                 else {
169                         BKE_reportf(data->reports, RPT_WARNING, "Path cant be made absolute \"%s\"", path_src);
170                         data->count_failed++;
171                 }
172                 return TRUE;
173         }
174 }
175
176 /* similar to makeFilesRelative - keep in sync! */
177 void makeFilesAbsolute(Main *bmain, const char *basedir, ReportList *reports)
178 {
179         BPathRemap_Data data= {NULL};
180
181         if(basedir[0] == '\0') {
182                 printf("%s: basedir='', this is a bug\n", __func__);
183                 return;
184         }
185
186         data.basedir= basedir;
187         data.reports= reports;
188
189         bpath_traverse_main(bmain, makeFilesAbsolute_visit_cb, 0, (void *)&data);
190
191         BKE_reportf(reports, data.count_failed ? RPT_WARNING : RPT_INFO,
192                     "Total files %d|Changed %d|Failed %d",
193                     data.count_tot, data.count_changed, data.count_failed);
194 }
195
196
197 /* find this file recursively, use the biggest file so thumbnails dont get used by mistake
198  - dir: subdir to search
199  - filename: set this filename
200  - filesize: filesize for the file
201 */
202 #define MAX_RECUR 16
203 static int findFileRecursive(char *filename_new,
204                              const char *dirname,
205                              const char *filename,
206                              int *filesize,
207                              int *recur_depth)
208 {
209         /* file searching stuff */
210         DIR *dir;
211         struct dirent *de;
212         struct stat status;
213         char path[FILE_MAX];
214         int size;
215
216         dir= opendir(dirname);
217
218         if (dir==NULL)
219                 return 0;
220
221         if (*filesize == -1)
222                 *filesize= 0; /* dir opened fine */
223
224         while ((de= readdir(dir)) != NULL) {
225
226                 if (strcmp(".", de->d_name)==0 || strcmp("..", de->d_name)==0)
227                         continue;
228
229                 BLI_join_dirfile(path, sizeof(path), dirname, de->d_name);
230
231                 if (stat(path, &status) != 0)
232                         continue; /* cant stat, dont bother with this file, could print debug info here */
233
234                 if (S_ISREG(status.st_mode)) { /* is file */
235                         if (strncmp(filename, de->d_name, FILE_MAX)==0) { /* name matches */
236                                 /* open the file to read its size */
237                                 size= status.st_size;
238                                 if ((size > 0) && (size > *filesize)) { /* find the biggest file */
239                                         *filesize= size;
240                                         BLI_strncpy(filename_new, path, FILE_MAX);
241                                 }
242                         }
243                 }
244                 else if (S_ISDIR(status.st_mode)) { /* is subdir */
245                         if (*recur_depth <= MAX_RECUR) {
246                                 (*recur_depth)++;
247                                 findFileRecursive(filename_new, path, filename, filesize, recur_depth);
248                                 (*recur_depth)--;
249                         }
250                 }
251         }
252         closedir(dir);
253         return 1;
254 }
255
256 typedef struct BPathFind_Data
257 {
258         const char *basedir;
259         char searchdir[FILE_MAX];
260         ReportList *reports;
261 } BPathFind_Data;
262
263 static int findMissingFiles_visit_cb(void *userdata, char *path_dst, const char *path_src)
264 {
265         BPathFind_Data *data= (BPathFind_Data *)userdata;
266         char filename_new[FILE_MAX];
267
268         int filesize= -1;
269         int recur_depth= 0;
270
271         findFileRecursive(filename_new,
272                           data->searchdir, BLI_path_basename((char *)path_src),
273                           &filesize, &recur_depth);
274
275         if (filesize == -1) { /* could not open dir */
276                 BKE_reportf(data->reports, RPT_WARNING,
277                             "Could not find \"%s\" in \"%s\"",
278                             BLI_path_basename((char *)path_src), data->searchdir);
279                 return FALSE;
280         }
281         else {
282                 strcpy(path_dst, filename_new);
283                 return TRUE;
284         }
285 }
286
287 void findMissingFiles(Main *bmain, const char *searchpath, ReportList *reports)
288 {
289         struct BPathFind_Data data= {NULL};
290
291         data.reports= reports;
292         BLI_split_dir_part(searchpath, data.searchdir, sizeof(data.searchdir));
293
294         bpath_traverse_main(bmain, findMissingFiles_visit_cb, 0, (void *)&data);
295 }
296
297 /* Run a visitor on a string, replacing the contents of the string as needed. */
298 static int rewrite_path_fixed(char *path, BPathVisitor visit_cb, const char *absbase, void *userdata)
299 {
300         char path_src_buf[FILE_MAX];
301         const char *path_src;
302         char path_dst[FILE_MAX];
303
304         if (absbase) {
305                 BLI_strncpy(path_src_buf, path, sizeof(path_src_buf));
306                 BLI_path_abs(path_src_buf, absbase);
307                 path_src= path_src_buf;
308         }
309         else {
310                 path_src= path;
311         }
312
313         if (visit_cb(userdata, path_dst, path_src)) {
314                 BLI_strncpy(path, path_dst, FILE_MAX);
315                 return TRUE;
316         }
317         else {
318                 return FALSE;
319         }
320 }
321
322 static int rewrite_path_fixed_dirfile(char path_dir[FILE_MAXDIR],
323                                       char path_file[FILE_MAXFILE],
324                                       BPathVisitor visit_cb,
325                                       const char *absbase,
326                                       void *userdata)
327 {
328         char path_src[FILE_MAX];
329         char path_dst[FILE_MAX];
330
331         BLI_join_dirfile(path_src, sizeof(path_src), path_dir, path_file);
332
333         if (absbase) {
334                 BLI_path_abs(path_src, absbase);
335         }
336
337         if (visit_cb(userdata, path_dst, (const char *)path_src)) {
338                 BLI_split_dirfile(path_dst, path_dir, path_file, FILE_MAXDIR, FILE_MAXFILE);
339                 return TRUE;
340         }
341         else {
342                 return FALSE;
343         }
344 }
345
346 static int rewrite_path_alloc(char **path, BPathVisitor visit_cb, const char *absbase, void *userdata)
347 {
348         char path_src_buf[FILE_MAX];
349         const char *path_src;
350         char path_dst[FILE_MAX];
351
352         if (absbase) {
353                 BLI_strncpy(path_src_buf, *path, sizeof(path_src_buf));
354                 BLI_path_abs(path_src_buf, absbase);
355                 path_src= path_src_buf;
356         }
357         else {
358                 path_src= *path;
359         }
360
361         if (visit_cb(userdata, path_dst, path_src)) {
362                 MEM_freeN((*path));
363                 (*path)= BLI_strdup(path_dst);
364                 return TRUE;
365         }
366         else {
367                 return FALSE;
368         }
369 }
370
371 /* Run visitor function 'visit' on all paths contained in 'id'. */
372 void bpath_traverse_id(Main *bmain, ID *id, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
373 {
374         Image *ima;
375         const char *absbase= (flag & BPATH_TRAVERSE_ABS) ? ID_BLEND_PATH(bmain, id) : NULL;
376
377         if ((flag & BPATH_TRAVERSE_SKIP_LIBRARY) && id->lib) {
378                 return;
379         }
380
381         switch(GS(id->name)) {
382         case ID_IM:
383                 ima= (Image *)id;
384                 if (ima->packedfile == NULL || (flag & BPATH_TRAVERSE_SKIP_PACKED) == 0) {
385                         if (ELEM3(ima->source, IMA_SRC_FILE, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE)) {
386                                 rewrite_path_fixed(ima->name, visit_cb, absbase, bpath_user_data);
387                         }
388                 }
389                 break;
390         case ID_BR:
391                 {
392                         Brush *brush= (Brush *)id;
393                         if (brush->icon_filepath[0]) {
394                                 rewrite_path_fixed(brush->icon_filepath, visit_cb, absbase, bpath_user_data);
395                         }
396                 }
397                 break;
398         case ID_OB:
399
400 #define BPATH_TRAVERSE_POINTCACHE(ptcaches)                                    \
401         {                                                                          \
402                 PointCache *cache;                                                     \
403                 for(cache= (ptcaches).first; cache; cache= cache->next) {              \
404                         if(cache->flag & PTCACHE_DISK_CACHE) {                             \
405                                 rewrite_path_fixed(cache->path,                                \
406                                                    visit_cb,                                   \
407                                                    absbase,                                    \
408                                                    bpath_user_data);                           \
409                         }                                                                  \
410                 }                                                                      \
411         }                                                                          \
412
413
414                 {
415                         Object *ob= (Object *)id;
416                         ModifierData *md;
417                         ParticleSystem *psys;
418
419
420                         /* do via modifiers instead */
421 #if 0
422                         if (ob->fluidsimSettings) {
423                                 rewrite_path_fixed(ob->fluidsimSettings->surfdataPath, visit_cb, absbase, bpath_user_data);
424                         }
425 #endif
426
427                         for (md= ob->modifiers.first; md; md= md->next) {
428                                 if (md->type == eModifierType_Fluidsim) {
429                                         FluidsimModifierData *fluidmd= (FluidsimModifierData *)md;
430                                         if (fluidmd->fss) {
431                                                 rewrite_path_fixed(fluidmd->fss->surfdataPath, visit_cb, absbase, bpath_user_data);
432                                         }
433                                 }
434                                 else if (md->type == eModifierType_Smoke) {
435                                         SmokeModifierData *smd= (SmokeModifierData *)md;
436                                         if(smd->type & MOD_SMOKE_TYPE_DOMAIN) {
437                                                 BPATH_TRAVERSE_POINTCACHE(smd->domain->ptcaches[0]);
438                                         }
439                                 }
440                                 else if (md->type==eModifierType_Cloth) {
441                                         ClothModifierData *clmd= (ClothModifierData*) md;
442                                         BPATH_TRAVERSE_POINTCACHE(clmd->ptcaches);
443                                 }
444                                 else if (md->type==eModifierType_Ocean) {
445                                         OceanModifierData *omd= (OceanModifierData*) md;
446                                         rewrite_path_fixed(omd->cachepath, visit_cb, absbase, bpath_user_data);
447                                 }
448                         }
449
450                         if (ob->soft) {
451                                 BPATH_TRAVERSE_POINTCACHE(ob->soft->ptcaches);
452                         }
453
454                         for (psys= ob->particlesystem.first; psys; psys= psys->next) {
455                                 BPATH_TRAVERSE_POINTCACHE(psys->ptcaches);
456                         }
457                 }
458
459 #undef BPATH_TRAVERSE_POINTCACHE
460
461                 break;
462         case ID_SO:
463                 {
464                         bSound *sound= (bSound *)id;
465                         if (sound->packedfile == NULL || (flag & BPATH_TRAVERSE_SKIP_PACKED) == 0) {
466                                 rewrite_path_fixed(sound->name, visit_cb, absbase, bpath_user_data);
467                         }
468                 }
469                 break;
470         case ID_TXT:
471                 if (((Text*)id)->name) {
472                         rewrite_path_alloc(&((Text *)id)->name, visit_cb, absbase, bpath_user_data);
473                 }
474                 break;
475         case ID_VF:
476                 {
477                         VFont *vf= (VFont *)id;
478                         if (vf->packedfile == NULL || (flag & BPATH_TRAVERSE_SKIP_PACKED) == 0) {
479                                 if (strcmp(vf->name, FO_BUILTIN_NAME) != 0) {
480                                         rewrite_path_fixed(((VFont *)id)->name, visit_cb, absbase, bpath_user_data);
481                                 }
482                         }
483                 }
484                 break;
485         case ID_TE:
486                 {
487                         Tex *tex = (Tex *)id;
488                         if (tex->plugin) {
489                                 /* FIXME: rewrite_path assumes path length of FILE_MAX, but
490                                            tex->plugin->name is 160. ... is this field even a path? */
491                                 //rewrite_path(tex->plugin->name, visit_cb, bpath_user_data);
492                         }
493                         if (tex->type == TEX_VOXELDATA && TEX_VD_IS_SOURCE_PATH(tex->vd->file_format)) {
494                                 rewrite_path_fixed(tex->vd->source_path, visit_cb, absbase, bpath_user_data);
495                         }
496                 }
497                 break;
498
499         case ID_SCE:
500                 {
501                         Scene *scene= (Scene *)id;
502                         SceneRenderLayer *srl= scene->r.layers.first;
503                         if (scene->ed) {
504                                 Sequence *seq;
505
506                                 SEQ_BEGIN(scene->ed, seq) {
507                                         if (SEQ_HAS_PATH(seq)) {
508                                                 if (ELEM(seq->type, SEQ_MOVIE, SEQ_SOUND)) {
509                                                         rewrite_path_fixed_dirfile(seq->strip->dir, seq->strip->stripdata->name,
510                                                                                    visit_cb, absbase, bpath_user_data);
511                                                 }
512                                                 else if (seq->type == SEQ_IMAGE) {
513                                                         /* might want an option not to loop over all strips */
514                                                         StripElem *se= seq->strip->stripdata;
515                                                         int len= MEM_allocN_len(se) / sizeof(*se);
516                                                         int i;
517
518                                                         if (flag & BPATH_TRAVERSE_SKIP_MULTIFILE) {
519                                                                 /* only operate on one path */
520                                                                 len= MIN2(1, len);
521                                                         }
522
523                                                         for(i= 0; i < len; i++, se++) {
524                                                                 rewrite_path_fixed_dirfile(seq->strip->dir, se->name,
525                                                                                            visit_cb, absbase, bpath_user_data);
526                                                         }
527                                                 }
528                                                 else {
529                                                         /* simple case */
530                                                         rewrite_path_fixed(seq->strip->dir, visit_cb, absbase, bpath_user_data);
531                                                 }
532                                         }
533                                         else if (seq->plugin) {
534                                                 rewrite_path_fixed(seq->plugin->name, visit_cb, absbase, bpath_user_data);
535                                         }
536
537                                 }
538                                 SEQ_END
539                         }
540                         for(; srl; srl= srl->next) {
541                                 FreestyleModuleConfig* module= srl->freestyleConfig.modules.first;
542                                 for (; module; module= module->next) {
543                                         rewrite_path_fixed(module->module_path, visit_cb, absbase, bpath_user_data);
544                                 }
545                         }
546                 }
547                 break;
548         case ID_ME:
549                 {
550                         Mesh *me= (Mesh *)id;
551                         if (me->fdata.external) {
552                                 rewrite_path_fixed(me->fdata.external->filename, visit_cb, absbase, bpath_user_data);
553                         }
554                 }
555                 break;
556         case ID_LI:
557                 {
558                         Library *lib= (Library *)id;
559                         if(rewrite_path_fixed(lib->name, visit_cb, absbase, bpath_user_data)) {
560                                 BKE_library_filepath_set(lib, lib->name);
561                         }
562                 }
563                 break;
564         case ID_MC:
565                 {
566                         MovieClip *clip= (MovieClip *)id;
567                         rewrite_path_fixed(clip->name, visit_cb, absbase, bpath_user_data);
568                 }
569                 break;
570         default:
571                 /* Nothing to do for other IDs that don't contain file paths. */
572                 break;
573         }
574 }
575
576 void bpath_traverse_id_list(Main *bmain, ListBase *lb, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
577 {
578         ID *id;
579         for(id= lb->first; id; id= id->next) {
580                 bpath_traverse_id(bmain, id, visit_cb, flag, bpath_user_data);
581         }
582 }
583
584 void bpath_traverse_main(Main *bmain, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
585 {
586         ListBase *lbarray[MAX_LIBARRAY];
587         int a= set_listbasepointers(bmain, lbarray);
588         while(a--) bpath_traverse_id_list(bmain, lbarray[a], visit_cb, flag, bpath_user_data);
589 }
590
591 /* Rewrites a relative path to be relative to the main file - unless the path is
592    absolute, in which case it is not altered. */
593 int bpath_relocate_visitor(void *pathbase_v, char *path_dst, const char *path_src)
594 {
595         /* be sure there is low chance of the path being too short */
596         char filepath[(FILE_MAXDIR * 2) + FILE_MAXFILE];
597         const char *base_new= ((char **)pathbase_v)[0];
598         const char *base_old= ((char **)pathbase_v)[1];
599
600         if (strncmp(base_old, "//", 2) == 0) {
601                 printf("%s: error, old base path '%s' is not absolute.\n",
602                        __func__, base_old);
603                 return FALSE;
604         }
605
606         /* Make referenced file absolute. This would be a side-effect of
607            BLI_cleanup_file, but we do it explicitely so we know if it changed. */
608         BLI_strncpy(filepath, path_src, FILE_MAX);
609         if (BLI_path_abs(filepath, base_old)) {
610                 /* Path was relative and is now absolute. Remap.
611                  * Important BLI_cleanup_dir runs before the path is made relative
612                  * because it wont work for paths that start with "//../" */
613                 BLI_cleanup_file(base_new, filepath);
614                 BLI_path_rel(filepath, base_new);
615                 BLI_strncpy(path_dst, filepath, FILE_MAX);
616                 return TRUE;
617         }
618         else {
619                 /* Path was not relative to begin with. */
620                 return FALSE;
621         }
622 }