ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / intern / bpath.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup bli
19  */
20
21 /* TODO,
22  * currently there are some cases we don't support.
23  * - passing output paths to the visitor?, like render out.
24  * - passing sequence strips with many images.
25  * - passing directory paths - visitors don't know which path is a dir or a file.
26  * */
27
28 #include <sys/stat.h>
29
30 #include <string.h>
31 #include <assert.h>
32
33 /* path/file handling stuff */
34 #ifndef WIN32
35 #  include <dirent.h>
36 #  include <unistd.h>
37 #else
38 #  include <io.h>
39 #  include "BLI_winstuff.h"
40 #endif
41
42 #include "MEM_guardedalloc.h"
43
44 #include "DNA_brush_types.h"
45 #include "DNA_cachefile_types.h"
46 #include "DNA_image_types.h"
47 #include "DNA_mesh_types.h"
48 #include "DNA_modifier_types.h"
49 #include "DNA_movieclip_types.h"
50 #include "DNA_object_fluidsim_types.h"
51 #include "DNA_object_force_types.h"
52 #include "DNA_object_types.h"
53 #include "DNA_particle_types.h"
54 #include "DNA_sequence_types.h"
55 #include "DNA_sound_types.h"
56 #include "DNA_text_types.h"
57 #include "DNA_material_types.h"
58 #include "DNA_node_types.h"
59 #include "DNA_texture_types.h"
60 #include "DNA_vfont_types.h"
61 #include "DNA_scene_types.h"
62 #include "DNA_smoke_types.h"
63 #include "DNA_freestyle_types.h"
64
65 #include "BLI_blenlib.h"
66 #include "BLI_utildefines.h"
67
68 #include "BKE_font.h"
69 #include "BKE_library.h"
70 #include "BKE_main.h"
71 #include "BKE_node.h"
72 #include "BKE_report.h"
73 #include "BKE_sequencer.h"
74 #include "BKE_image.h"
75
76 #include "BKE_bpath.h" /* own include */
77
78 #include "CLG_log.h"
79
80 #ifndef _MSC_VER
81 #  include "BLI_strict_flags.h"
82 #endif
83
84 static CLG_LogRef LOG = {"bke.bpath"};
85
86 static bool checkMissingFiles_visit_cb(void *userdata,
87                                        char *UNUSED(path_dst),
88                                        const char *path_src)
89 {
90   ReportList *reports = (ReportList *)userdata;
91
92   if (!BLI_exists(path_src)) {
93     BKE_reportf(reports, RPT_WARNING, "Path '%s' not found", path_src);
94   }
95
96   return false;
97 }
98
99 /* high level function */
100 void BKE_bpath_missing_files_check(Main *bmain, ReportList *reports)
101 {
102   BKE_bpath_traverse_main(bmain,
103                           checkMissingFiles_visit_cb,
104                           BKE_BPATH_TRAVERSE_ABS | BKE_BPATH_TRAVERSE_SKIP_PACKED,
105                           reports);
106 }
107
108 typedef struct BPathRemap_Data {
109   const char *basedir;
110   ReportList *reports;
111
112   int count_tot;
113   int count_changed;
114   int count_failed;
115 } BPathRemap_Data;
116
117 static bool bpath_relative_convert_visit_cb(void *userdata, char *path_dst, const char *path_src)
118 {
119   BPathRemap_Data *data = (BPathRemap_Data *)userdata;
120
121   data->count_tot++;
122
123   if (BLI_path_is_rel(path_src)) {
124     return false; /* already relative */
125   }
126   else {
127     strcpy(path_dst, path_src);
128     BLI_path_rel(path_dst, data->basedir);
129     if (BLI_path_is_rel(path_dst)) {
130       data->count_changed++;
131     }
132     else {
133       BKE_reportf(data->reports, RPT_WARNING, "Path '%s' cannot be made relative", path_src);
134       data->count_failed++;
135     }
136     return true;
137   }
138 }
139
140 void BKE_bpath_relative_convert(Main *bmain, const char *basedir, ReportList *reports)
141 {
142   BPathRemap_Data data = {NULL};
143   const int flag = BKE_BPATH_TRAVERSE_SKIP_LIBRARY;
144
145   if (basedir[0] == '\0') {
146     CLOG_ERROR(&LOG, "basedir='', this is a bug");
147     return;
148   }
149
150   data.basedir = basedir;
151   data.reports = reports;
152
153   BKE_bpath_traverse_main(bmain, bpath_relative_convert_visit_cb, flag, (void *)&data);
154
155   BKE_reportf(reports,
156               data.count_failed ? RPT_WARNING : RPT_INFO,
157               "Total files %d | Changed %d | Failed %d",
158               data.count_tot,
159               data.count_changed,
160               data.count_failed);
161 }
162
163 static bool bpath_absolute_convert_visit_cb(void *userdata, char *path_dst, const char *path_src)
164 {
165   BPathRemap_Data *data = (BPathRemap_Data *)userdata;
166
167   data->count_tot++;
168
169   if (BLI_path_is_rel(path_src) == false) {
170     return false; /* already absolute */
171   }
172   else {
173     strcpy(path_dst, path_src);
174     BLI_path_abs(path_dst, data->basedir);
175     if (BLI_path_is_rel(path_dst) == false) {
176       data->count_changed++;
177     }
178     else {
179       BKE_reportf(data->reports, RPT_WARNING, "Path '%s' cannot be made absolute", path_src);
180       data->count_failed++;
181     }
182     return true;
183   }
184 }
185
186 /* similar to BKE_bpath_relative_convert - keep in sync! */
187 void BKE_bpath_absolute_convert(Main *bmain, const char *basedir, ReportList *reports)
188 {
189   BPathRemap_Data data = {NULL};
190   const int flag = BKE_BPATH_TRAVERSE_SKIP_LIBRARY;
191
192   if (basedir[0] == '\0') {
193     CLOG_ERROR(&LOG, "basedir='', this is a bug");
194     return;
195   }
196
197   data.basedir = basedir;
198   data.reports = reports;
199
200   BKE_bpath_traverse_main(bmain, bpath_absolute_convert_visit_cb, flag, (void *)&data);
201
202   BKE_reportf(reports,
203               data.count_failed ? RPT_WARNING : RPT_INFO,
204               "Total files %d | Changed %d | Failed %d",
205               data.count_tot,
206               data.count_changed,
207               data.count_failed);
208 }
209
210 /**
211  * find this file recursively, use the biggest file so thumbnails don't get used by mistake
212  * \param filename_new: the path will be copied here, caller must initialize as empty string.
213  * \param dirname: subdir to search
214  * \param filename: set this filename
215  * \param filesize: filesize for the file
216  *
217  * \returns found: 1/0.
218  */
219 #define MAX_RECUR 16
220 static bool missing_files_find__recursive(char *filename_new,
221                                           const char *dirname,
222                                           const char *filename,
223                                           int64_t *r_filesize,
224                                           int *r_recur_depth)
225 {
226   /* file searching stuff */
227   DIR *dir;
228   struct dirent *de;
229   BLI_stat_t status;
230   char path[FILE_MAX];
231   int64_t size;
232   bool found = false;
233
234   dir = opendir(dirname);
235
236   if (dir == NULL)
237     return found;
238
239   if (*r_filesize == -1)
240     *r_filesize = 0; /* dir opened fine */
241
242   while ((de = readdir(dir)) != NULL) {
243
244     if (FILENAME_IS_CURRPAR(de->d_name))
245       continue;
246
247     BLI_join_dirfile(path, sizeof(path), dirname, de->d_name);
248
249     if (BLI_stat(path, &status) == -1)
250       continue; /* cant stat, don't bother with this file, could print debug info here */
251
252     if (S_ISREG(status.st_mode)) {                              /* is file */
253       if (BLI_path_ncmp(filename, de->d_name, FILE_MAX) == 0) { /* name matches */
254         /* open the file to read its size */
255         size = status.st_size;
256         if ((size > 0) && (size > *r_filesize)) { /* find the biggest file */
257           *r_filesize = size;
258           BLI_strncpy(filename_new, path, FILE_MAX);
259           found = true;
260         }
261       }
262     }
263     else if (S_ISDIR(status.st_mode)) { /* is subdir */
264       if (*r_recur_depth <= MAX_RECUR) {
265         (*r_recur_depth)++;
266         found |= missing_files_find__recursive(
267             filename_new, path, filename, r_filesize, r_recur_depth);
268         (*r_recur_depth)--;
269       }
270     }
271   }
272   closedir(dir);
273   return found;
274 }
275
276 typedef struct BPathFind_Data {
277   const char *basedir;
278   const char *searchdir;
279   ReportList *reports;
280   bool find_all;
281 } BPathFind_Data;
282
283 static bool missing_files_find__visit_cb(void *userdata, char *path_dst, const char *path_src)
284 {
285   BPathFind_Data *data = (BPathFind_Data *)userdata;
286   char filename_new[FILE_MAX];
287
288   int64_t filesize = -1;
289   int recur_depth = 0;
290   bool found;
291
292   if (data->find_all == false) {
293     if (BLI_exists(path_src)) {
294       return false;
295     }
296   }
297
298   filename_new[0] = '\0';
299
300   found = missing_files_find__recursive(
301       filename_new, data->searchdir, BLI_path_basename(path_src), &filesize, &recur_depth);
302
303   if (filesize == -1) { /* could not open dir */
304     BKE_reportf(data->reports,
305                 RPT_WARNING,
306                 "Could not open directory '%s'",
307                 BLI_path_basename(data->searchdir));
308     return false;
309   }
310   else if (found == false) {
311     BKE_reportf(data->reports,
312                 RPT_WARNING,
313                 "Could not find '%s' in '%s'",
314                 BLI_path_basename(path_src),
315                 data->searchdir);
316     return false;
317   }
318   else {
319     bool was_relative = BLI_path_is_rel(path_dst);
320
321     BLI_strncpy(path_dst, filename_new, FILE_MAX);
322
323     /* keep path relative if the previous one was relative */
324     if (was_relative)
325       BLI_path_rel(path_dst, data->basedir);
326
327     return true;
328   }
329 }
330
331 void BKE_bpath_missing_files_find(Main *bmain,
332                                   const char *searchpath,
333                                   ReportList *reports,
334                                   const bool find_all)
335 {
336   struct BPathFind_Data data = {NULL};
337   const int flag = BKE_BPATH_TRAVERSE_ABS | BKE_BPATH_TRAVERSE_RELOAD_EDITED;
338
339   data.basedir = BKE_main_blendfile_path(bmain);
340   data.reports = reports;
341   data.searchdir = searchpath;
342   data.find_all = find_all;
343
344   BKE_bpath_traverse_main(bmain, missing_files_find__visit_cb, flag, (void *)&data);
345 }
346
347 /* Run a visitor on a string, replacing the contents of the string as needed. */
348 static bool rewrite_path_fixed(char *path,
349                                BPathVisitor visit_cb,
350                                const char *absbase,
351                                void *userdata)
352 {
353   char path_src_buf[FILE_MAX];
354   const char *path_src;
355   char path_dst[FILE_MAX];
356
357   if (absbase) {
358     BLI_strncpy(path_src_buf, path, sizeof(path_src_buf));
359     BLI_path_abs(path_src_buf, absbase);
360     path_src = path_src_buf;
361   }
362   else {
363     path_src = path;
364   }
365
366   /* so functions can check old value */
367   BLI_strncpy(path_dst, path, FILE_MAX);
368
369   if (visit_cb(userdata, path_dst, path_src)) {
370     BLI_strncpy(path, path_dst, FILE_MAX);
371     return true;
372   }
373   else {
374     return false;
375   }
376 }
377
378 static bool rewrite_path_fixed_dirfile(char path_dir[FILE_MAXDIR],
379                                        char path_file[FILE_MAXFILE],
380                                        BPathVisitor visit_cb,
381                                        const char *absbase,
382                                        void *userdata)
383 {
384   char path_src[FILE_MAX];
385   char path_dst[FILE_MAX];
386
387   BLI_join_dirfile(path_src, sizeof(path_src), path_dir, path_file);
388
389   /* so functions can check old value */
390   BLI_strncpy(path_dst, path_src, FILE_MAX);
391
392   if (absbase) {
393     BLI_path_abs(path_src, absbase);
394   }
395
396   if (visit_cb(userdata, path_dst, (const char *)path_src)) {
397     BLI_split_dirfile(path_dst, path_dir, path_file, FILE_MAXDIR, FILE_MAXFILE);
398     return true;
399   }
400   else {
401     return false;
402   }
403 }
404
405 static bool rewrite_path_alloc(char **path,
406                                BPathVisitor visit_cb,
407                                const char *absbase,
408                                void *userdata)
409 {
410   char path_src_buf[FILE_MAX];
411   const char *path_src;
412   char path_dst[FILE_MAX];
413
414   if (absbase) {
415     BLI_strncpy(path_src_buf, *path, sizeof(path_src_buf));
416     BLI_path_abs(path_src_buf, absbase);
417     path_src = path_src_buf;
418   }
419   else {
420     path_src = *path;
421   }
422
423   if (visit_cb(userdata, path_dst, path_src)) {
424     MEM_freeN(*path);
425     (*path) = BLI_strdup(path_dst);
426     return true;
427   }
428   else {
429     return false;
430   }
431 }
432
433 /* Run visitor function 'visit' on all paths contained in 'id'. */
434 void BKE_bpath_traverse_id(
435     Main *bmain, ID *id, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
436 {
437   const char *absbase = (flag & BKE_BPATH_TRAVERSE_ABS) ? ID_BLEND_PATH(bmain, id) : NULL;
438
439   if ((flag & BKE_BPATH_TRAVERSE_SKIP_LIBRARY) && ID_IS_LINKED(id)) {
440     return;
441   }
442
443   switch (GS(id->name)) {
444     case ID_IM: {
445       Image *ima;
446       ima = (Image *)id;
447       if (BKE_image_has_packedfile(ima) == false || (flag & BKE_BPATH_TRAVERSE_SKIP_PACKED) == 0) {
448         if (ELEM(ima->source, IMA_SRC_FILE, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE)) {
449           if (rewrite_path_fixed(ima->name, visit_cb, absbase, bpath_user_data)) {
450             if (flag & BKE_BPATH_TRAVERSE_RELOAD_EDITED) {
451               if (!BKE_image_has_packedfile(ima) &&
452                   /* image may have been painted onto (and not saved, T44543) */
453                   !BKE_image_is_dirty(ima)) {
454                 BKE_image_signal(bmain, ima, NULL, IMA_SIGNAL_RELOAD);
455               }
456             }
457           }
458         }
459       }
460       break;
461     }
462     case ID_BR: {
463       Brush *brush = (Brush *)id;
464       if (brush->icon_filepath[0]) {
465         rewrite_path_fixed(brush->icon_filepath, visit_cb, absbase, bpath_user_data);
466       }
467       break;
468     }
469     case ID_OB: {
470       Object *ob = (Object *)id;
471       ModifierData *md;
472       ParticleSystem *psys;
473
474 #define BPATH_TRAVERSE_POINTCACHE(ptcaches) \
475   { \
476     PointCache *cache; \
477     for (cache = (ptcaches).first; cache; cache = cache->next) { \
478       if (cache->flag & PTCACHE_DISK_CACHE) { \
479         rewrite_path_fixed(cache->path, visit_cb, absbase, bpath_user_data); \
480       } \
481     } \
482   } \
483   (void)0
484
485       for (md = ob->modifiers.first; md; md = md->next) {
486         if (md->type == eModifierType_Fluidsim) {
487           FluidsimModifierData *fluidmd = (FluidsimModifierData *)md;
488           if (fluidmd->fss) {
489             rewrite_path_fixed(fluidmd->fss->surfdataPath, visit_cb, absbase, bpath_user_data);
490           }
491         }
492         else if (md->type == eModifierType_Smoke) {
493           SmokeModifierData *smd = (SmokeModifierData *)md;
494           if (smd->type & MOD_SMOKE_TYPE_DOMAIN) {
495             BPATH_TRAVERSE_POINTCACHE(smd->domain->ptcaches[0]);
496           }
497         }
498         else if (md->type == eModifierType_Cloth) {
499           ClothModifierData *clmd = (ClothModifierData *)md;
500           BPATH_TRAVERSE_POINTCACHE(clmd->ptcaches);
501         }
502         else if (md->type == eModifierType_Ocean) {
503           OceanModifierData *omd = (OceanModifierData *)md;
504           rewrite_path_fixed(omd->cachepath, visit_cb, absbase, bpath_user_data);
505         }
506         else if (md->type == eModifierType_MeshCache) {
507           MeshCacheModifierData *mcmd = (MeshCacheModifierData *)md;
508           rewrite_path_fixed(mcmd->filepath, visit_cb, absbase, bpath_user_data);
509         }
510       }
511
512       if (ob->soft) {
513         BPATH_TRAVERSE_POINTCACHE(ob->soft->shared->ptcaches);
514       }
515
516       for (psys = ob->particlesystem.first; psys; psys = psys->next) {
517         BPATH_TRAVERSE_POINTCACHE(psys->ptcaches);
518       }
519
520 #undef BPATH_TRAVERSE_POINTCACHE
521
522       break;
523     }
524     case ID_SO: {
525       bSound *sound = (bSound *)id;
526       if (sound->packedfile == NULL || (flag & BKE_BPATH_TRAVERSE_SKIP_PACKED) == 0) {
527         rewrite_path_fixed(sound->name, visit_cb, absbase, bpath_user_data);
528       }
529       break;
530     }
531     case ID_TXT:
532       if (((Text *)id)->name) {
533         rewrite_path_alloc(&((Text *)id)->name, visit_cb, absbase, bpath_user_data);
534       }
535       break;
536     case ID_VF: {
537       VFont *vfont = (VFont *)id;
538       if (vfont->packedfile == NULL || (flag & BKE_BPATH_TRAVERSE_SKIP_PACKED) == 0) {
539         if (BKE_vfont_is_builtin(vfont) == false) {
540           rewrite_path_fixed(((VFont *)id)->name, visit_cb, absbase, bpath_user_data);
541         }
542       }
543       break;
544     }
545     case ID_MA: {
546       Material *ma = (Material *)id;
547       bNodeTree *ntree = ma->nodetree;
548
549       if (ntree) {
550         bNode *node;
551
552         for (node = ntree->nodes.first; node; node = node->next) {
553           if (node->type == SH_NODE_SCRIPT) {
554             NodeShaderScript *nss = (NodeShaderScript *)node->storage;
555             rewrite_path_fixed(nss->filepath, visit_cb, absbase, bpath_user_data);
556           }
557           else if (node->type == SH_NODE_TEX_IES) {
558             NodeShaderTexIES *ies = (NodeShaderTexIES *)node->storage;
559             rewrite_path_fixed(ies->filepath, visit_cb, absbase, bpath_user_data);
560           }
561         }
562       }
563       break;
564     }
565     case ID_NT: {
566       bNodeTree *ntree = (bNodeTree *)id;
567       bNode *node;
568
569       if (ntree->type == NTREE_SHADER) {
570         /* same as lines above */
571         for (node = ntree->nodes.first; node; node = node->next) {
572           if (node->type == SH_NODE_SCRIPT) {
573             NodeShaderScript *nss = (NodeShaderScript *)node->storage;
574             rewrite_path_fixed(nss->filepath, visit_cb, absbase, bpath_user_data);
575           }
576           else if (node->type == SH_NODE_TEX_IES) {
577             NodeShaderTexIES *ies = (NodeShaderTexIES *)node->storage;
578             rewrite_path_fixed(ies->filepath, visit_cb, absbase, bpath_user_data);
579           }
580         }
581       }
582       break;
583     }
584     case ID_SCE: {
585       Scene *scene = (Scene *)id;
586       if (scene->ed) {
587         Sequence *seq;
588
589         SEQ_BEGIN (scene->ed, seq) {
590           if (SEQ_HAS_PATH(seq)) {
591             StripElem *se = seq->strip->stripdata;
592
593             if (ELEM(seq->type, SEQ_TYPE_MOVIE, SEQ_TYPE_SOUND_RAM) && se) {
594               rewrite_path_fixed_dirfile(
595                   seq->strip->dir, se->name, visit_cb, absbase, bpath_user_data);
596             }
597             else if ((seq->type == SEQ_TYPE_IMAGE) && se) {
598               /* might want an option not to loop over all strips */
599               unsigned int len = (unsigned int)MEM_allocN_len(se) / (unsigned int)sizeof(*se);
600               unsigned int i;
601
602               if (flag & BKE_BPATH_TRAVERSE_SKIP_MULTIFILE) {
603                 /* only operate on one path */
604                 len = MIN2(1u, len);
605               }
606
607               for (i = 0; i < len; i++, se++) {
608                 rewrite_path_fixed_dirfile(
609                     seq->strip->dir, se->name, visit_cb, absbase, bpath_user_data);
610               }
611             }
612             else {
613               /* simple case */
614               rewrite_path_fixed(seq->strip->dir, visit_cb, absbase, bpath_user_data);
615             }
616           }
617         }
618         SEQ_END;
619       }
620       break;
621     }
622     case ID_ME: {
623       Mesh *me = (Mesh *)id;
624       if (me->ldata.external) {
625         rewrite_path_fixed(me->ldata.external->filename, visit_cb, absbase, bpath_user_data);
626       }
627       break;
628     }
629     case ID_LI: {
630       Library *lib = (Library *)id;
631       /* keep packedfile paths always relative to the blend */
632       if (lib->packedfile == NULL) {
633         if (rewrite_path_fixed(lib->name, visit_cb, absbase, bpath_user_data)) {
634           BKE_library_filepath_set(bmain, lib, lib->name);
635         }
636       }
637       break;
638     }
639     case ID_MC: {
640       MovieClip *clip = (MovieClip *)id;
641       rewrite_path_fixed(clip->name, visit_cb, absbase, bpath_user_data);
642       break;
643     }
644     case ID_CF: {
645       CacheFile *cache_file = (CacheFile *)id;
646       rewrite_path_fixed(cache_file->filepath, visit_cb, absbase, bpath_user_data);
647       break;
648     }
649     default:
650       /* Nothing to do for other IDs that don't contain file paths. */
651       break;
652   }
653 }
654
655 void BKE_bpath_traverse_id_list(
656     Main *bmain, ListBase *lb, BPathVisitor visit_cb, const int flag, void *bpath_user_data)
657 {
658   ID *id;
659   for (id = lb->first; id; id = id->next) {
660     BKE_bpath_traverse_id(bmain, id, visit_cb, flag, bpath_user_data);
661   }
662 }
663
664 void BKE_bpath_traverse_main(Main *bmain,
665                              BPathVisitor visit_cb,
666                              const int flag,
667                              void *bpath_user_data)
668 {
669   ListBase *lbarray[MAX_LIBARRAY];
670   int a = set_listbasepointers(bmain, lbarray);
671   while (a--) {
672     BKE_bpath_traverse_id_list(bmain, lbarray[a], visit_cb, flag, bpath_user_data);
673   }
674 }
675
676 /* Rewrites a relative path to be relative to the main file - unless the path is
677  * absolute, in which case it is not altered. */
678 bool BKE_bpath_relocate_visitor(void *pathbase_v, char *path_dst, const char *path_src)
679 {
680   /* be sure there is low chance of the path being too short */
681   char filepath[(FILE_MAXDIR * 2) + FILE_MAXFILE];
682   const char *base_new = ((char **)pathbase_v)[0];
683   const char *base_old = ((char **)pathbase_v)[1];
684
685   if (BLI_path_is_rel(base_old)) {
686     CLOG_ERROR(&LOG, "old base path '%s' is not absolute.", base_old);
687     return false;
688   }
689
690   /* Make referenced file absolute. This would be a side-effect of
691    * BLI_cleanup_file, but we do it explicitly so we know if it changed. */
692   BLI_strncpy(filepath, path_src, FILE_MAX);
693   if (BLI_path_abs(filepath, base_old)) {
694     /* Path was relative and is now absolute. Remap.
695      * Important BLI_cleanup_dir runs before the path is made relative
696      * because it wont work for paths that start with "//../" */
697     BLI_cleanup_file(base_new, filepath);
698     BLI_path_rel(filepath, base_new);
699     BLI_strncpy(path_dst, filepath, FILE_MAX);
700     return true;
701   }
702   else {
703     /* Path was not relative to begin with. */
704     return false;
705   }
706 }
707
708 /* -------------------------------------------------------------------- */
709 /**
710  * Backup/Restore/Free functions,
711  * \note These functions assume the data won't change order.
712  */
713
714 struct PathStore {
715   struct PathStore *next, *prev;
716 };
717
718 static bool bpath_list_append(void *userdata, char *UNUSED(path_dst), const char *path_src)
719 {
720   /* store the path and string in a single alloc */
721   ListBase *ls = userdata;
722   size_t path_size = strlen(path_src) + 1;
723   struct PathStore *path_store = MEM_mallocN(sizeof(struct PathStore) + path_size, __func__);
724   char *filepath = (char *)(path_store + 1);
725
726   memcpy(filepath, path_src, path_size);
727   BLI_addtail(ls, path_store);
728   return false;
729 }
730
731 static bool bpath_list_restore(void *userdata, char *path_dst, const char *path_src)
732 {
733   /* assume ls->first wont be NULL because the number of paths can't change!
734    * (if they do caller is wrong) */
735   ListBase *ls = userdata;
736   struct PathStore *path_store = ls->first;
737   const char *filepath = (char *)(path_store + 1);
738   bool ret;
739
740   if (STREQ(path_src, filepath)) {
741     ret = false;
742   }
743   else {
744     BLI_strncpy(path_dst, filepath, FILE_MAX);
745     ret = true;
746   }
747
748   BLI_freelinkN(ls, path_store);
749   return ret;
750 }
751
752 /* return ls_handle */
753 void *BKE_bpath_list_backup(Main *bmain, const int flag)
754 {
755   ListBase *ls = MEM_callocN(sizeof(ListBase), __func__);
756
757   BKE_bpath_traverse_main(bmain, bpath_list_append, flag, ls);
758
759   return ls;
760 }
761
762 void BKE_bpath_list_restore(Main *bmain, const int flag, void *ls_handle)
763 {
764   ListBase *ls = ls_handle;
765
766   BKE_bpath_traverse_main(bmain, bpath_list_restore, flag, ls);
767 }
768
769 void BKE_bpath_list_free(void *ls_handle)
770 {
771   ListBase *ls = ls_handle;
772   BLI_assert(BLI_listbase_is_empty(ls)); /* assumes we were used */
773   BLI_freelistN(ls);
774   MEM_freeN(ls);
775 }