code cleanup:
[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 don't support.
34  * - passing output paths to the visitor?, like render out.
35  * - passing sequence strips with many images.
36  * - passing directory paths - visitors don't 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 handling 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
72 #include "BLI_blenlib.h"
73 #include "BLI_bpath.h"
74 #include "BLI_utildefines.h"
75
76 #include "BKE_font.h"
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 BLI_bpath_missing_files_check(Main *bmain, ReportList *reports)
97 {
98         BLI_bpath_traverse_main(bmain, checkMissingFiles_visit_cb, BLI_BPATH_TRAVERSE_ABS, reports);
99 }
100
101 typedef struct BPathRemap_Data {
102         const char *basedir;
103         ReportList *reports;
104
105         int count_tot;
106         int count_changed;
107         int count_failed;
108 } BPathRemap_Data;
109
110 static int makeFilesRelative_visit_cb(void *userdata, char *path_dst, const char *path_src)
111 {
112         BPathRemap_Data *data = (BPathRemap_Data *)userdata;
113
114         data->count_tot++;
115
116         if (strncmp(path_src, "//", 2) == 0) {
117                 return FALSE; /* already relative */
118         }
119         else {
120                 strcpy(path_dst, path_src);
121                 BLI_path_rel(path_dst, data->basedir);
122                 if (strncmp(path_dst, "//", 2) == 0) {
123                         data->count_changed++;
124                 }
125                 else {
126                         BKE_reportf(data->reports, RPT_WARNING, "Path cant be made relative \"%s\"", path_src);
127                         data->count_failed++;
128                 }
129                 return TRUE;
130         }
131 }
132
133 void BLI_bpath_relative_convert(Main *bmain, const char *basedir, ReportList *reports)
134 {
135         BPathRemap_Data data = {NULL};
136
137         if (basedir[0] == '\0') {
138                 printf("%s: basedir='', this is a bug\n", __func__);
139                 return;
140         }
141
142         data.basedir = basedir;
143         data.reports = reports;
144
145         BLI_bpath_traverse_main(bmain, makeFilesRelative_visit_cb, 0, (void *)&data);
146
147         BKE_reportf(reports, data.count_failed ? RPT_WARNING : RPT_INFO,
148                     "Total files %d|Changed %d|Failed %d",
149                     data.count_tot, data.count_changed, data.count_failed);
150 }
151
152 static int makeFilesAbsolute_visit_cb(void *userdata, char *path_dst, const char *path_src)
153 {
154         BPathRemap_Data *data = (BPathRemap_Data *)userdata;
155
156         data->count_tot++;
157
158         if (strncmp(path_src, "//", 2) != 0) {
159                 return FALSE; /* already absolute */
160         }
161         else {
162                 strcpy(path_dst, path_src);
163                 BLI_path_abs(path_dst, data->basedir);
164                 if (strncmp(path_dst, "//", 2) != 0) {
165                         data->count_changed++;
166                 }
167                 else {
168                         BKE_reportf(data->reports, RPT_WARNING, "Path cant be made absolute \"%s\"", path_src);
169                         data->count_failed++;
170                 }
171                 return TRUE;
172         }
173 }
174
175 /* similar to BLI_bpath_relative_convert - keep in sync! */
176 void BLI_bpath_absolute_convert(Main *bmain, const char *basedir, ReportList *reports)
177 {
178         BPathRemap_Data data = {NULL};
179
180         if (basedir[0] == '\0') {
181                 printf("%s: basedir='', this is a bug\n", __func__);
182                 return;
183         }
184
185         data.basedir = basedir;
186         data.reports = reports;
187
188         BLI_bpath_traverse_main(bmain, makeFilesAbsolute_visit_cb, 0, (void *)&data);
189
190         BKE_reportf(reports, data.count_failed ? RPT_WARNING : RPT_INFO,
191                     "Total files %d|Changed %d|Failed %d",
192                     data.count_tot, data.count_changed, data.count_failed);
193 }
194
195 /**
196  * find this file recursively, use the biggest file so thumbnails don't get used by mistake
197  * \param filename_new: the path will be copied here, caller must initialize as empyu string.
198  * \param dirname: subdir to search
199  * \param filename: set this filename
200  * \param filesize: filesize for the file
201  *
202  * \returns found: 1/0.
203  */
204 #define MAX_RECUR 16
205 static int findFileRecursive(char *filename_new,
206                              const char *dirname,
207                              const char *filename,
208                              int *filesize,
209                              int *recur_depth)
210 {
211         /* file searching stuff */
212         DIR *dir;
213         struct dirent *de;
214         struct stat status;
215         char path[FILE_MAX];
216         int size;
217         int found = FALSE;
218
219         dir = opendir(dirname);
220
221         if (dir == NULL)
222                 return found;
223
224         if (*filesize == -1)
225                 *filesize = 0;  /* dir opened fine */
226
227         while ((de = readdir(dir)) != NULL) {
228
229                 if (strcmp(".", de->d_name) == 0 || strcmp("..", de->d_name) == 0)
230                         continue;
231
232                 BLI_join_dirfile(path, sizeof(path), dirname, de->d_name);
233
234                 if (stat(path, &status) != 0)
235                         continue;  /* cant stat, don't bother with this file, could print debug info here */
236
237                 if (S_ISREG(status.st_mode)) { /* is file */
238                         if (strncmp(filename, de->d_name, FILE_MAX) == 0) { /* name matches */
239                                 /* open the file to read its size */
240                                 size = status.st_size;
241                                 if ((size > 0) && (size > *filesize)) { /* find the biggest file */
242                                         *filesize = size;
243                                         BLI_strncpy(filename_new, path, FILE_MAX);
244                                         found = TRUE;
245                                 }
246                         }
247                 }
248                 else if (S_ISDIR(status.st_mode)) { /* is subdir */
249                         if (*recur_depth <= MAX_RECUR) {
250                                 (*recur_depth)++;
251                                 found |= findFileRecursive(filename_new, path, filename, filesize, recur_depth);
252                                 (*recur_depth)--;
253                         }
254                 }
255         }
256         closedir(dir);
257         return found;
258 }
259
260 typedef struct BPathFind_Data {
261         const char *basedir;
262         char searchdir[FILE_MAX];
263         ReportList *reports;
264 } BPathFind_Data;
265
266 static int findMissingFiles_visit_cb(void *userdata, char *path_dst, const char *path_src)
267 {
268         BPathFind_Data *data = (BPathFind_Data *)userdata;
269         char filename_new[FILE_MAX];
270
271         int filesize = -1;
272         int recur_depth = 0;
273         int found;
274
275         filename_new[0] = '\0';
276
277         found = findFileRecursive(filename_new,
278                                   data->searchdir, BLI_path_basename((char *)path_src),
279                                   &filesize, &recur_depth);
280
281         if (filesize == -1) { /* could not open dir */
282                 BKE_reportf(data->reports, RPT_WARNING,
283                             "Could open directory \"%s\"",
284                             BLI_path_basename(data->searchdir));
285                 return FALSE;
286         }
287         else if (found == FALSE) {
288                 BKE_reportf(data->reports, RPT_WARNING,
289                             "Could not find \"%s\" in \"%s\"",
290                             BLI_path_basename((char *)path_src), data->searchdir);
291                 return FALSE;
292         }
293         else {
294                 BLI_strncpy(path_dst, filename_new, FILE_MAX);
295                 return TRUE;
296         }
297 }
298
299 void BLI_bpath_missing_files_find(Main *bmain, const char *searchpath, ReportList *reports)
300 {
301         struct BPathFind_Data data = {NULL};
302
303         data.reports = reports;
304         BLI_split_dir_part(searchpath, data.searchdir, sizeof(data.searchdir));
305
306         BLI_bpath_traverse_main(bmain, findMissingFiles_visit_cb, 0, (void *)&data);
307 }
308
309 /* Run a visitor on a string, replacing the contents of the string as needed. */
310 static int rewrite_path_fixed(char *path, BPathVisitor visit_cb, const char *absbase, void *userdata)
311 {
312         char path_src_buf[FILE_MAX];
313         const char *path_src;
314         char path_dst[FILE_MAX];
315
316         if (absbase) {
317                 BLI_strncpy(path_src_buf, path, sizeof(path_src_buf));
318                 BLI_path_abs(path_src_buf, absbase);
319                 path_src = path_src_buf;
320         }
321         else {
322                 path_src = path;
323         }
324
325         if (visit_cb(userdata, path_dst, path_src)) {
326                 BLI_strncpy(path, path_dst, FILE_MAX);
327                 return TRUE;
328         }
329         else {
330                 return FALSE;
331         }
332 }
333
334 static int rewrite_path_fixed_dirfile(char path_dir[FILE_MAXDIR],
335                                       char path_file[FILE_MAXFILE],
336                                       BPathVisitor visit_cb,
337                                       const char *absbase,
338                                       void *userdata)
339 {
340         char path_src[FILE_MAX];
341         char path_dst[FILE_MAX];
342
343         BLI_join_dirfile(path_src, sizeof(path_src), path_dir, path_file);
344
345         if (absbase) {
346                 BLI_path_abs(path_src, absbase);
347         }
348
349         if (visit_cb(userdata, path_dst, (const char *)path_src)) {
350                 BLI_split_dirfile(path_dst, path_dir, path_file, FILE_MAXDIR, FILE_MAXFILE);
351                 return TRUE;
352         }
353         else {
354                 return FALSE;
355         }
356 }
357
358 static int rewrite_path_alloc(char **path, BPathVisitor visit_cb, const char *absbase, void *userdata)
359 {
360         char path_src_buf[FILE_MAX];
361         const char *path_src;
362         char path_dst[FILE_MAX];
363
364         if (absbase) {
365                 BLI_strncpy(path_src_buf, *path, sizeof(path_src_buf));
366                 BLI_path_abs(path_src_buf, absbase);
367                 path_src = path_src_buf;
368         }
369         else {
370                 path_src = *path;
371         }
372
373         if (visit_cb(userdata, path_dst, path_src)) {
374                 MEM_freeN((*path));
375                 (*path) = BLI_strdup(path_dst);
376                 return TRUE;
377         }
378         else {
379                 return FALSE;
380         }
381 }
382
383 /* Run visitor function 'visit' on all paths contained in 'id'. */
384 void BLI_bpath_traverse_id(Main *bmain, ID *id, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
385 {
386         Image *ima;
387         const char *absbase = (flag & BLI_BPATH_TRAVERSE_ABS) ? ID_BLEND_PATH(bmain, id) : NULL;
388
389         if ((flag & BLI_BPATH_TRAVERSE_SKIP_LIBRARY) && id->lib) {
390                 return;
391         }
392
393         switch (GS(id->name)) {
394                 case ID_IM:
395                         ima = (Image *)id;
396                         if (ima->packedfile == NULL || (flag & BLI_BPATH_TRAVERSE_SKIP_PACKED) == 0) {
397                                 if (ELEM3(ima->source, IMA_SRC_FILE, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE)) {
398                                         rewrite_path_fixed(ima->name, visit_cb, absbase, bpath_user_data);
399                                 }
400                         }
401                         break;
402                 case ID_BR:
403                 {
404                         Brush *brush = (Brush *)id;
405                         if (brush->icon_filepath[0]) {
406                                 rewrite_path_fixed(brush->icon_filepath, visit_cb, absbase, bpath_user_data);
407                         }
408                 }
409                 break;
410                 case ID_OB:
411
412 #define BPATH_TRAVERSE_POINTCACHE(ptcaches)                                    \
413         {                                                                          \
414                 PointCache *cache;                                                     \
415                 for (cache = (ptcaches).first; cache; cache = cache->next) {           \
416                         if (cache->flag & PTCACHE_DISK_CACHE) {                            \
417                                 rewrite_path_fixed(cache->path,                                \
418                                                    visit_cb,                                   \
419                                                    absbase,                                    \
420                                                    bpath_user_data);                           \
421                         }                                                                  \
422                 }                                                                      \
423         } (void)0
424
425
426                         {
427                                 Object *ob = (Object *)id;
428                                 ModifierData *md;
429                                 ParticleSystem *psys;
430
431                                 /* do via modifiers instead */
432 #if 0
433                                 if (ob->fluidsimSettings) {
434                                         rewrite_path_fixed(ob->fluidsimSettings->surfdataPath, visit_cb, absbase, bpath_user_data);
435                                 }
436 #endif
437
438                                 for (md = ob->modifiers.first; md; md = md->next) {
439                                         if (md->type == eModifierType_Fluidsim) {
440                                                 FluidsimModifierData *fluidmd = (FluidsimModifierData *)md;
441                                                 if (fluidmd->fss) {
442                                                         rewrite_path_fixed(fluidmd->fss->surfdataPath, visit_cb, absbase, bpath_user_data);
443                                                 }
444                                         }
445                                         else if (md->type == eModifierType_Smoke) {
446                                                 SmokeModifierData *smd = (SmokeModifierData *)md;
447                                                 if (smd->type & MOD_SMOKE_TYPE_DOMAIN) {
448                                                         BPATH_TRAVERSE_POINTCACHE(smd->domain->ptcaches[0]);
449                                                 }
450                                         }
451                                         else if (md->type == eModifierType_Cloth) {
452                                                 ClothModifierData *clmd = (ClothModifierData *) md;
453                                                 BPATH_TRAVERSE_POINTCACHE(clmd->ptcaches);
454                                         }
455                                         else if (md->type == eModifierType_Ocean) {
456                                                 OceanModifierData *omd = (OceanModifierData *) md;
457                                                 rewrite_path_fixed(omd->cachepath, visit_cb, absbase, bpath_user_data);
458                                         }
459                                 }
460
461                                 if (ob->soft) {
462                                         BPATH_TRAVERSE_POINTCACHE(ob->soft->ptcaches);
463                                 }
464
465                                 for (psys = ob->particlesystem.first; psys; psys = psys->next) {
466                                         BPATH_TRAVERSE_POINTCACHE(psys->ptcaches);
467                                 }
468                         }
469
470 #undef BPATH_TRAVERSE_POINTCACHE
471
472                         break;
473                 case ID_SO:
474                 {
475                         bSound *sound = (bSound *)id;
476                         if (sound->packedfile == NULL || (flag & BLI_BPATH_TRAVERSE_SKIP_PACKED) == 0) {
477                                 rewrite_path_fixed(sound->name, visit_cb, absbase, bpath_user_data);
478                         }
479                 }
480                 break;
481                 case ID_TXT:
482                         if (((Text *)id)->name) {
483                                 rewrite_path_alloc(&((Text *)id)->name, visit_cb, absbase, bpath_user_data);
484                         }
485                         break;
486                 case ID_VF:
487                 {
488                         VFont *vfont = (VFont *)id;
489                         if (vfont->packedfile == NULL || (flag & BLI_BPATH_TRAVERSE_SKIP_PACKED) == 0) {
490                                 if (BKE_vfont_is_builtin(vfont) == FALSE) {
491                                         rewrite_path_fixed(((VFont *)id)->name, visit_cb, absbase, bpath_user_data);
492                                 }
493                         }
494                 }
495                 break;
496                 case ID_TE:
497                 {
498                         Tex *tex = (Tex *)id;
499                         if (tex->type == TEX_VOXELDATA && TEX_VD_IS_SOURCE_PATH(tex->vd->file_format)) {
500                                 rewrite_path_fixed(tex->vd->source_path, visit_cb, absbase, bpath_user_data);
501                         }
502                 }
503                 break;
504
505                 case ID_SCE:
506                 {
507                         Scene *scene = (Scene *)id;
508                         if (scene->ed) {
509                                 Sequence *seq;
510
511                                 SEQ_BEGIN(scene->ed, seq)
512                                 {
513                                         if (SEQ_HAS_PATH(seq)) {
514                                                 if (ELEM(seq->type, SEQ_TYPE_MOVIE, SEQ_TYPE_SOUND_RAM)) {
515                                                         rewrite_path_fixed_dirfile(seq->strip->dir, seq->strip->stripdata->name,
516                                                                                    visit_cb, absbase, bpath_user_data);
517                                                 }
518                                                 else if (seq->type == SEQ_TYPE_IMAGE) {
519                                                         /* might want an option not to loop over all strips */
520                                                         StripElem *se = seq->strip->stripdata;
521                                                         int len = MEM_allocN_len(se) / sizeof(*se);
522                                                         int i;
523
524                                                         if (flag & BLI_BPATH_TRAVERSE_SKIP_MULTIFILE) {
525                                                                 /* only operate on one path */
526                                                                 len = MIN2(1, len);
527                                                         }
528
529                                                         for (i = 0; i < len; i++, se++) {
530                                                                 rewrite_path_fixed_dirfile(seq->strip->dir, se->name,
531                                                                                            visit_cb, absbase, bpath_user_data);
532                                                         }
533                                                 }
534                                                 else {
535                                                         /* simple case */
536                                                         rewrite_path_fixed(seq->strip->dir, visit_cb, absbase, bpath_user_data);
537                                                 }
538                                         }
539
540                                 }
541                                 SEQ_END
542                         }
543                 }
544                 break;
545                 case ID_ME:
546                 {
547                         Mesh *me = (Mesh *)id;
548                         if (me->fdata.external) {
549                                 rewrite_path_fixed(me->fdata.external->filename, visit_cb, absbase, bpath_user_data);
550                         }
551                 }
552                 break;
553                 case ID_LI:
554                 {
555                         Library *lib = (Library *)id;
556                         if (rewrite_path_fixed(lib->name, visit_cb, absbase, bpath_user_data)) {
557                                 BKE_library_filepath_set(lib, lib->name);
558                         }
559                 }
560                 break;
561                 case ID_MC:
562                 {
563                         MovieClip *clip = (MovieClip *)id;
564                         rewrite_path_fixed(clip->name, visit_cb, absbase, bpath_user_data);
565                 }
566                 break;
567                 default:
568                         /* Nothing to do for other IDs that don't contain file paths. */
569                         break;
570         }
571 }
572
573 void BLI_bpath_traverse_id_list(Main *bmain, ListBase *lb, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
574 {
575         ID *id;
576         for (id = lb->first; id; id = id->next) {
577                 BLI_bpath_traverse_id(bmain, id, visit_cb, flag, bpath_user_data);
578         }
579 }
580
581 void BLI_bpath_traverse_main(Main *bmain, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
582 {
583         ListBase *lbarray[MAX_LIBARRAY];
584         int a = set_listbasepointers(bmain, lbarray);
585         while (a--) {
586                 BLI_bpath_traverse_id_list(bmain, lbarray[a], visit_cb, flag, bpath_user_data);
587         }
588 }
589
590 /* Rewrites a relative path to be relative to the main file - unless the path is
591  * absolute, in which case it is not altered. */
592 int BLI_bpath_relocate_visitor(void *pathbase_v, char *path_dst, const char *path_src)
593 {
594         /* be sure there is low chance of the path being too short */
595         char filepath[(FILE_MAXDIR * 2) + FILE_MAXFILE];
596         const char *base_new = ((char **)pathbase_v)[0];
597         const char *base_old = ((char **)pathbase_v)[1];
598
599         if (strncmp(base_old, "//", 2) == 0) {
600                 printf("%s: error, old base path '%s' is not absolute.\n",
601                        __func__, base_old);
602                 return FALSE;
603         }
604
605         /* Make referenced file absolute. This would be a side-effect of
606          * BLI_cleanup_file, but we do it explicitly so we know if it changed. */
607         BLI_strncpy(filepath, path_src, FILE_MAX);
608         if (BLI_path_abs(filepath, base_old)) {
609                 /* Path was relative and is now absolute. Remap.
610                  * Important BLI_cleanup_dir runs before the path is made relative
611                  * because it wont work for paths that start with "//../" */
612                 BLI_cleanup_file(base_new, filepath);
613                 BLI_path_rel(filepath, base_new);
614                 BLI_strncpy(path_dst, filepath, FILE_MAX);
615                 return TRUE;
616         }
617         else {
618                 /* Path was not relative to begin with. */
619                 return FALSE;
620         }
621 }