Merged changes in the trunk up to revision 42692.
[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, const char *dirname, const char *filename, int *filesize, int *recur_depth)
204 {
205         /* file searching stuff */
206         DIR *dir;
207         struct dirent *de;
208         struct stat status;
209         char path[FILE_MAX];
210         int size;
211
212         dir= opendir(dirname);
213
214         if (dir==NULL)
215                 return 0;
216
217         if (*filesize == -1)
218                 *filesize= 0; /* dir opened fine */
219
220         while ((de= readdir(dir)) != NULL) {
221
222                 if (strcmp(".", de->d_name)==0 || strcmp("..", de->d_name)==0)
223                         continue;
224
225                 BLI_join_dirfile(path, sizeof(path), dirname, de->d_name);
226
227                 if (stat(path, &status) != 0)
228                         continue; /* cant stat, dont bother with this file, could print debug info here */
229
230                 if (S_ISREG(status.st_mode)) { /* is file */
231                         if (strncmp(filename, de->d_name, FILE_MAX)==0) { /* name matches */
232                                 /* open the file to read its size */
233                                 size= status.st_size;
234                                 if ((size > 0) && (size > *filesize)) { /* find the biggest file */
235                                         *filesize= size;
236                                         BLI_strncpy(filename_new, path, FILE_MAX);
237                                 }
238                         }
239                 }
240                 else if (S_ISDIR(status.st_mode)) { /* is subdir */
241                         if (*recur_depth <= MAX_RECUR) {
242                                 (*recur_depth)++;
243                                 findFileRecursive(filename_new, path, filename, filesize, recur_depth);
244                                 (*recur_depth)--;
245                         }
246                 }
247         }
248         closedir(dir);
249         return 1;
250 }
251
252 typedef struct BPathFind_Data
253 {
254         const char *basedir;
255         char searchdir[FILE_MAX];
256         ReportList *reports;
257 } BPathFind_Data;
258
259 static int findMissingFiles_visit_cb(void *userdata, char *path_dst, const char *path_src)
260 {
261         BPathFind_Data *data= (BPathFind_Data *)userdata;
262         char filename_new[FILE_MAX];
263
264         int filesize= -1;
265         int recur_depth= 0;
266
267         findFileRecursive(filename_new,
268                           data->searchdir, BLI_path_basename((char *)path_src),
269                           &filesize, &recur_depth);
270
271         if (filesize == -1) { /* could not open dir */
272                 BKE_reportf(data->reports, RPT_WARNING,
273                             "Could not find \"%s\" in \"%s\"",
274                             BLI_path_basename((char *)path_src), data->searchdir);
275                 return FALSE;
276         }
277         else {
278                 strcpy(path_dst, filename_new);
279                 return TRUE;
280         }
281 }
282
283 void findMissingFiles(Main *bmain, const char *searchpath, ReportList *reports)
284 {
285         struct BPathFind_Data data= {NULL};
286
287         data.reports= reports;
288         BLI_split_dir_part(searchpath, data.searchdir, sizeof(data.searchdir));
289
290         bpath_traverse_main(bmain, findMissingFiles_visit_cb, 0, (void *)&data);
291 }
292
293 /* Run a visitor on a string, replacing the contents of the string as needed. */
294 static int rewrite_path_fixed(char *path, BPathVisitor visit_cb, const char *absbase, void *userdata)
295 {
296         char path_src_buf[FILE_MAX];
297         const char *path_src;
298         char path_dst[FILE_MAX];
299
300         if (absbase) {
301                 BLI_strncpy(path_src_buf, path, sizeof(path_src_buf));
302                 BLI_path_abs(path_src_buf, absbase);
303                 path_src= path_src_buf;
304         }
305         else {
306                 path_src= path;
307         }
308
309         if (visit_cb(userdata, path_dst, path_src)) {
310                 BLI_strncpy(path, path_dst, FILE_MAX);
311                 return TRUE;
312         }
313         else {
314                 return FALSE;
315         }
316 }
317
318 static int rewrite_path_fixed_dirfile(char path_dir[FILE_MAXDIR], char path_file[FILE_MAXFILE], BPathVisitor visit_cb, const char *absbase, void *userdata)
319 {
320         char path_src[FILE_MAX];
321         char path_dst[FILE_MAX];
322
323         BLI_join_dirfile(path_src, sizeof(path_src), path_dir, path_file);
324
325         if (absbase) {
326                 BLI_path_abs(path_src, absbase);
327         }
328
329         if (visit_cb(userdata, path_dst, (const char *)path_src)) {
330                 BLI_split_dirfile(path_dst, path_dir, path_file, FILE_MAXDIR, FILE_MAXFILE);
331                 return TRUE;
332         }
333         else {
334                 return FALSE;
335         }
336 }
337
338 static int rewrite_path_alloc(char **path, BPathVisitor visit_cb, const char *absbase, void *userdata)
339 {
340         char path_src_buf[FILE_MAX];
341         const char *path_src;
342         char path_dst[FILE_MAX];
343
344         if (absbase) {
345                 BLI_strncpy(path_src_buf, *path, sizeof(path_src_buf));
346                 BLI_path_abs(path_src_buf, absbase);
347                 path_src= path_src_buf;
348         }
349         else {
350                 path_src= *path;
351         }
352
353         if (visit_cb(userdata, path_dst, path_src)) {
354                 MEM_freeN((*path));
355                 (*path)= BLI_strdup(path_dst);
356                 return TRUE;
357         }
358         else {
359                 return FALSE;
360         }
361 }
362
363 /* Run visitor function 'visit' on all paths contained in 'id'. */
364 void bpath_traverse_id(Main *bmain, ID *id, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
365 {
366         Image *ima;
367         const char *absbase= (flag & BPATH_TRAVERSE_ABS) ? ID_BLEND_PATH(bmain, id) : NULL;
368
369         if ((flag & BPATH_TRAVERSE_SKIP_LIBRARY) && id->lib) {
370                 return;
371         }
372
373         switch(GS(id->name)) {
374         case ID_IM:
375                 ima= (Image *)id;
376                 if (ima->packedfile == NULL || (flag & BPATH_TRAVERSE_SKIP_PACKED) == 0) {
377                         if (ELEM3(ima->source, IMA_SRC_FILE, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE)) {
378                                 rewrite_path_fixed(ima->name, visit_cb, absbase, bpath_user_data);
379                         }
380                 }
381                 break;
382         case ID_BR:
383                 {
384                         Brush *brush= (Brush *)id;
385                         if (brush->icon_filepath[0]) {
386                                 rewrite_path_fixed(brush->icon_filepath, visit_cb, absbase, bpath_user_data);
387                         }
388                 }
389                 break;
390         case ID_OB:
391
392 #define BPATH_TRAVERSE_POINTCACHE(ptcaches)                                    \
393         {                                                                          \
394                 PointCache *cache;                                                     \
395                 for(cache= (ptcaches).first; cache; cache= cache->next) {              \
396                         if(cache->flag & PTCACHE_DISK_CACHE) {                             \
397                                 rewrite_path_fixed(cache->path,                                \
398                                                    visit_cb,                                   \
399                                                    absbase,                                    \
400                                                    bpath_user_data);                           \
401                         }                                                                  \
402                 }                                                                      \
403         }                                                                          \
404
405
406                 {
407                         Object *ob= (Object *)id;
408                         ModifierData *md;
409                         ParticleSystem *psys;
410
411
412                         /* do via modifiers instead */
413 #if 0
414                         if (ob->fluidsimSettings) {
415                                 rewrite_path_fixed(ob->fluidsimSettings->surfdataPath, visit_cb, absbase, bpath_user_data);
416                         }
417 #endif
418
419                         for (md= ob->modifiers.first; md; md= md->next) {
420                                 if (md->type == eModifierType_Fluidsim) {
421                                         FluidsimModifierData *fluidmd= (FluidsimModifierData *)md;
422                                         if (fluidmd->fss) {
423                                                 rewrite_path_fixed(fluidmd->fss->surfdataPath, visit_cb, absbase, bpath_user_data);
424                                         }
425                                 }
426                                 else if (md->type == eModifierType_Smoke) {
427                                         SmokeModifierData *smd= (SmokeModifierData *)md;
428                                         if(smd->type & MOD_SMOKE_TYPE_DOMAIN) {
429                                                 BPATH_TRAVERSE_POINTCACHE(smd->domain->ptcaches[0]);
430                                         }
431                                 }
432                                 else if (md->type==eModifierType_Cloth) {
433                                         ClothModifierData *clmd= (ClothModifierData*) md;
434                                         BPATH_TRAVERSE_POINTCACHE(clmd->ptcaches);
435                                 }
436                                 else if (md->type==eModifierType_Ocean) {
437                                         OceanModifierData *omd= (OceanModifierData*) md;
438                                         rewrite_path_fixed(omd->cachepath, visit_cb, absbase, bpath_user_data);
439                                 }
440                         }
441
442                         if (ob->soft) {
443                                 BPATH_TRAVERSE_POINTCACHE(ob->soft->ptcaches);
444                         }
445
446                         for (psys= ob->particlesystem.first; psys; psys= psys->next) {
447                                 BPATH_TRAVERSE_POINTCACHE(psys->ptcaches);
448                         }
449                 }
450
451 #undef BPATH_TRAVERSE_POINTCACHE
452
453                 break;
454         case ID_SO:
455                 {
456                         bSound *sound= (bSound *)id;
457                         if (sound->packedfile == NULL || (flag & BPATH_TRAVERSE_SKIP_PACKED) == 0) {
458                                 rewrite_path_fixed(sound->name, visit_cb, absbase, bpath_user_data);
459                         }
460                 }
461                 break;
462         case ID_TXT:
463                 if (((Text*)id)->name) {
464                         rewrite_path_alloc(&((Text *)id)->name, visit_cb, absbase, bpath_user_data);
465                 }
466                 break;
467         case ID_VF:
468                 {
469                         VFont *vf= (VFont *)id;
470                         if (vf->packedfile == NULL || (flag & BPATH_TRAVERSE_SKIP_PACKED) == 0) {
471                                 if (strcmp(vf->name, FO_BUILTIN_NAME) != 0) {
472                                         rewrite_path_fixed(((VFont *)id)->name, visit_cb, absbase, bpath_user_data);
473                                 }
474                         }
475                 }
476                 break;
477         case ID_TE:
478                 {
479                         Tex *tex = (Tex *)id;
480                         if (tex->plugin) {
481                                 /* FIXME: rewrite_path assumes path length of FILE_MAX, but
482                                            tex->plugin->name is 160. ... is this field even a path? */
483                                 //rewrite_path(tex->plugin->name, visit_cb, bpath_user_data);
484                         }
485                         if (tex->type == TEX_VOXELDATA && TEX_VD_IS_SOURCE_PATH(tex->vd->file_format)) {
486                                 rewrite_path_fixed(tex->vd->source_path, visit_cb, absbase, bpath_user_data);
487                         }
488                 }
489                 break;
490
491         case ID_SCE:
492                 {
493                         Scene *scene= (Scene *)id;
494                         SceneRenderLayer *srl= scene->r.layers.first;
495                         if (scene->ed) {
496                                 Sequence *seq;
497
498                                 SEQ_BEGIN(scene->ed, seq) {
499                                         if (SEQ_HAS_PATH(seq)) {
500                                                 if (ELEM(seq->type, SEQ_MOVIE, SEQ_SOUND)) {
501                                                         rewrite_path_fixed_dirfile(seq->strip->dir, seq->strip->stripdata->name, visit_cb, absbase, bpath_user_data);
502                                                 }
503                                                 else if (seq->type == SEQ_IMAGE) {
504                                                         /* might want an option not to loop over all strips */
505                                                         StripElem *se= seq->strip->stripdata;
506                                                         int len= MEM_allocN_len(se) / sizeof(*se);
507                                                         int i;
508
509                                                         if (flag & BPATH_TRAVERSE_SKIP_MULTIFILE) {
510                                                                 /* only operate on one path */
511                                                                 len= MIN2(1, len);
512                                                         }
513
514                                                         for(i= 0; i < len; i++, se++) {
515                                                                 rewrite_path_fixed_dirfile(seq->strip->dir, se->name, visit_cb, absbase, bpath_user_data);
516                                                         }
517                                                 }
518                                                 else {
519                                                         /* simple case */
520                                                         rewrite_path_fixed(seq->strip->dir, visit_cb, absbase, bpath_user_data);
521                                                 }
522                                         }
523                                         else if (seq->plugin) {
524                                                 rewrite_path_fixed(seq->plugin->name, visit_cb, absbase, bpath_user_data);
525                                         }
526
527                                 }
528                                 SEQ_END
529                         }
530                         for(; srl; srl= srl->next) {
531                                 FreestyleModuleConfig* module= srl->freestyleConfig.modules.first;
532                                 for (; module; module= module->next) {
533                                         rewrite_path_fixed(module->module_path, visit_cb, absbase, bpath_user_data);
534                                 }
535                         }
536                 }
537                 break;
538         case ID_ME:
539                 {
540                         Mesh *me= (Mesh *)id;
541                         if (me->fdata.external) {
542                                 rewrite_path_fixed(me->fdata.external->filename, visit_cb, absbase, bpath_user_data);
543                         }
544                 }
545                 break;
546         case ID_LI:
547                 {
548                         Library *lib= (Library *)id;
549                         if(rewrite_path_fixed(lib->name, visit_cb, absbase, bpath_user_data)) {
550                                 BKE_library_filepath_set(lib, lib->name);
551                         }
552                 }
553                 break;
554         case ID_MC:
555                 {
556                         MovieClip *clip= (MovieClip *)id;
557                         rewrite_path_fixed(clip->name, visit_cb, absbase, bpath_user_data);
558                 }
559                 break;
560         default:
561                 /* Nothing to do for other IDs that don't contain file paths. */
562                 break;
563         }
564 }
565
566 void bpath_traverse_id_list(Main *bmain, ListBase *lb, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
567 {
568         ID *id;
569         for(id= lb->first; id; id= id->next) {
570                 bpath_traverse_id(bmain, id, visit_cb, flag, bpath_user_data);
571         }
572 }
573
574 void bpath_traverse_main(Main *bmain, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
575 {
576         ListBase *lbarray[MAX_LIBARRAY];
577         int a= set_listbasepointers(bmain, lbarray);
578         while(a--) bpath_traverse_id_list(bmain, lbarray[a], visit_cb, flag, bpath_user_data);
579 }
580
581 /* Rewrites a relative path to be relative to the main file - unless the path is
582    absolute, in which case it is not altered. */
583 int bpath_relocate_visitor(void *pathbase_v, char *path_dst, const char *path_src)
584 {
585         /* be sure there is low chance of the path being too short */
586         char filepath[(FILE_MAXDIR * 2) + FILE_MAXFILE];
587         const char *base_new= ((char **)pathbase_v)[0];
588         const char *base_old= ((char **)pathbase_v)[1];
589
590         if (strncmp(base_old, "//", 2) == 0) {
591                 printf("%s: error, old base path '%s' is not absolute.\n",
592                        __func__, base_old);
593                 return FALSE;
594         }
595
596         /* Make referenced file absolute. This would be a side-effect of
597            BLI_cleanup_file, but we do it explicitely so we know if it changed. */
598         BLI_strncpy(filepath, path_src, FILE_MAX);
599         if (BLI_path_abs(filepath, base_old)) {
600                 /* Path was relative and is now absolute. Remap.
601                  * Important BLI_cleanup_dir runs before the path is made relative
602                  * because it wont work for paths that start with "//../" */
603                 BLI_cleanup_file(base_new, filepath);
604                 BLI_path_rel(filepath, base_new);
605                 BLI_strncpy(path_dst, filepath, FILE_MAX);
606                 return TRUE;
607         }
608         else {
609                 /* Path was not relative to begin with. */
610                 return FALSE;
611         }
612 }