14c032e6ffa44a5a78e45e4a673ff2e13a64218c
[blender.git] / source / blender / windowmanager / intern / wm_files_link.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  * The Original Code is Copyright (C) 2007 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup wm
22  *
23  * Functions for dealing with append/link operators and helpers.
24  */
25
26 #include <float.h>
27 #include <string.h>
28 #include <ctype.h>
29 #include <stdio.h>
30 #include <stddef.h>
31 #include <assert.h>
32 #include <errno.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_ID.h"
37 #include "DNA_screen_types.h"
38 #include "DNA_scene_types.h"
39 #include "DNA_windowmanager_types.h"
40
41 #include "BLI_blenlib.h"
42 #include "BLI_bitmap.h"
43 #include "BLI_linklist.h"
44 #include "BLI_math.h"
45 #include "BLI_memarena.h"
46 #include "BLI_utildefines.h"
47 #include "BLI_ghash.h"
48
49 #include "BLO_readfile.h"
50
51 #include "BKE_context.h"
52 #include "BKE_global.h"
53 #include "BKE_layer.h"
54 #include "BKE_library.h"
55 #include "BKE_library_remap.h"
56 #include "BKE_main.h"
57 #include "BKE_report.h"
58 #include "BKE_scene.h"
59
60 #include "BKE_idcode.h"
61
62 #include "DEG_depsgraph.h"
63 #include "DEG_depsgraph_build.h"
64
65 #include "IMB_colormanagement.h"
66
67 #include "ED_datafiles.h"
68 #include "ED_screen.h"
69
70 #include "RNA_access.h"
71 #include "RNA_define.h"
72
73 #include "WM_api.h"
74 #include "WM_types.h"
75
76 #include "wm_files.h"
77
78 /* **************** link/append *************** */
79
80 static bool wm_link_append_poll(bContext *C)
81 {
82   if (WM_operator_winactive(C)) {
83     /* linking changes active object which is pretty useful in general,
84      * but which totally confuses edit mode (i.e. it becoming not so obvious
85      * to leave from edit mode and invalid tools in toolbar might be displayed)
86      * so disable link/append when in edit mode (sergey) */
87     if (CTX_data_edit_object(C)) {
88       return 0;
89     }
90
91     return 1;
92   }
93
94   return 0;
95 }
96
97 static int wm_link_append_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
98 {
99   if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
100     if (G.lib[0] != '\0') {
101       RNA_string_set(op->ptr, "filepath", G.lib);
102     }
103     else if (G.relbase_valid) {
104       char path[FILE_MAX];
105       BLI_strncpy(path, BKE_main_blendfile_path_from_global(), sizeof(path));
106       BLI_parent_dir(path);
107       RNA_string_set(op->ptr, "filepath", path);
108     }
109   }
110
111   WM_event_add_fileselect(C, op);
112   return OPERATOR_RUNNING_MODAL;
113 }
114
115 static short wm_link_append_flag(wmOperator *op)
116 {
117   PropertyRNA *prop;
118   short flag = 0;
119
120   if (RNA_boolean_get(op->ptr, "autoselect")) {
121     flag |= FILE_AUTOSELECT;
122   }
123   if (RNA_boolean_get(op->ptr, "active_collection")) {
124     flag |= FILE_ACTIVE_COLLECTION;
125   }
126   if ((prop = RNA_struct_find_property(op->ptr, "relative_path")) &&
127       RNA_property_boolean_get(op->ptr, prop)) {
128     flag |= FILE_RELPATH;
129   }
130   if (RNA_boolean_get(op->ptr, "link")) {
131     flag |= FILE_LINK;
132   }
133   if (RNA_boolean_get(op->ptr, "instance_collections")) {
134     flag |= FILE_GROUP_INSTANCE;
135   }
136
137   return flag;
138 }
139
140 typedef struct WMLinkAppendDataItem {
141   char *name;
142   BLI_bitmap
143       *libraries; /* All libs (from WMLinkAppendData.libraries) to try to load this ID from. */
144   short idcode;
145
146   ID *new_id;
147   void *customdata;
148 } WMLinkAppendDataItem;
149
150 typedef struct WMLinkAppendData {
151   LinkNodePair libraries;
152   LinkNodePair items;
153   int num_libraries;
154   int num_items;
155   int flag; /* Combines eFileSel_Params_Flag from DNA_space_types.h and BLO_LibLinkFlags from BLO_readfile.h */
156
157   /* Internal 'private' data */
158   MemArena *memarena;
159 } WMLinkAppendData;
160
161 static WMLinkAppendData *wm_link_append_data_new(const int flag)
162 {
163   MemArena *ma = BLI_memarena_new(BLI_MEMARENA_STD_BUFSIZE, __func__);
164   WMLinkAppendData *lapp_data = BLI_memarena_calloc(ma, sizeof(*lapp_data));
165
166   lapp_data->flag = flag;
167   lapp_data->memarena = ma;
168
169   return lapp_data;
170 }
171
172 static void wm_link_append_data_free(WMLinkAppendData *lapp_data)
173 {
174   BLI_memarena_free(lapp_data->memarena);
175 }
176
177 /* WARNING! *Never* call wm_link_append_data_library_add() after having added some items! */
178
179 static void wm_link_append_data_library_add(WMLinkAppendData *lapp_data, const char *libname)
180 {
181   size_t len = strlen(libname) + 1;
182   char *libpath = BLI_memarena_alloc(lapp_data->memarena, len);
183
184   BLI_strncpy(libpath, libname, len);
185   BLI_linklist_append_arena(&lapp_data->libraries, libpath, lapp_data->memarena);
186   lapp_data->num_libraries++;
187 }
188
189 static WMLinkAppendDataItem *wm_link_append_data_item_add(WMLinkAppendData *lapp_data,
190                                                           const char *idname,
191                                                           const short idcode,
192                                                           void *customdata)
193 {
194   WMLinkAppendDataItem *item = BLI_memarena_alloc(lapp_data->memarena, sizeof(*item));
195   size_t len = strlen(idname) + 1;
196
197   item->name = BLI_memarena_alloc(lapp_data->memarena, len);
198   BLI_strncpy(item->name, idname, len);
199   item->idcode = idcode;
200   item->libraries = BLI_BITMAP_NEW_MEMARENA(lapp_data->memarena, lapp_data->num_libraries);
201
202   item->new_id = NULL;
203   item->customdata = customdata;
204
205   BLI_linklist_append_arena(&lapp_data->items, item, lapp_data->memarena);
206   lapp_data->num_items++;
207
208   return item;
209 }
210
211 static void wm_link_do(WMLinkAppendData *lapp_data,
212                        ReportList *reports,
213                        Main *bmain,
214                        Scene *scene,
215                        ViewLayer *view_layer,
216                        const View3D *v3d)
217 {
218   Main *mainl;
219   BlendHandle *bh;
220   Library *lib;
221
222   const int flag = lapp_data->flag;
223
224   LinkNode *liblink, *itemlink;
225   int lib_idx, item_idx;
226
227   BLI_assert(lapp_data->num_items && lapp_data->num_libraries);
228
229   for (lib_idx = 0, liblink = lapp_data->libraries.list; liblink;
230        lib_idx++, liblink = liblink->next) {
231     char *libname = liblink->link;
232
233     if (STREQ(libname, BLO_EMBEDDED_STARTUP_BLEND)) {
234       bh = BLO_blendhandle_from_memory(datatoc_startup_blend, datatoc_startup_blend_size);
235     }
236     else {
237       bh = BLO_blendhandle_from_file(libname, reports);
238     }
239
240     if (bh == NULL) {
241       /* Unlikely since we just browsed it, but possible
242        * Error reports will have been made by BLO_blendhandle_from_file() */
243       continue;
244     }
245
246     /* here appending/linking starts */
247     mainl = BLO_library_link_begin(bmain, &bh, libname);
248     lib = mainl->curlib;
249     BLI_assert(lib);
250     UNUSED_VARS_NDEBUG(lib);
251
252     if (mainl->versionfile < 250) {
253       BKE_reportf(reports,
254                   RPT_WARNING,
255                   "Linking or appending from a very old .blend file format (%d.%d), no animation "
256                   "conversion will "
257                   "be done! You may want to re-save your lib file with current Blender",
258                   mainl->versionfile,
259                   mainl->subversionfile);
260     }
261
262     /* For each lib file, we try to link all items belonging to that lib,
263      * and tag those successful to not try to load them again with the other libs. */
264     for (item_idx = 0, itemlink = lapp_data->items.list; itemlink;
265          item_idx++, itemlink = itemlink->next) {
266       WMLinkAppendDataItem *item = itemlink->link;
267       ID *new_id;
268
269       if (!BLI_BITMAP_TEST(item->libraries, lib_idx)) {
270         continue;
271       }
272
273       new_id = BLO_library_link_named_part_ex(mainl, &bh, item->idcode, item->name, flag);
274
275       if (new_id) {
276         /* If the link is successful, clear item's libs 'todo' flags.
277          * This avoids trying to link same item with other libraries to come. */
278         BLI_bitmap_set_all(item->libraries, false, lapp_data->num_libraries);
279         item->new_id = new_id;
280       }
281     }
282
283     BLO_library_link_end(mainl, &bh, flag, bmain, scene, view_layer, v3d);
284     BLO_blendhandle_close(bh);
285   }
286 }
287
288 /**
289  * Check if an item defined by \a name and \a group can be appended/linked.
290  *
291  * \param reports: Optionally report an error when an item can't be appended/linked.
292  */
293 static bool wm_link_append_item_poll(ReportList *reports,
294                                      const char *path,
295                                      const char *group,
296                                      const char *name,
297                                      const bool do_append)
298 {
299   short idcode;
300
301   if (!group || !name) {
302     printf("skipping %s\n", path);
303     return false;
304   }
305
306   idcode = BKE_idcode_from_name(group);
307
308   /* XXX For now, we do a nasty exception for workspace, forbid linking them.
309    *     Not nice, ultimately should be solved! */
310   if (!BKE_idcode_is_linkable(idcode) && (do_append || idcode != ID_WS)) {
311     if (reports) {
312       if (do_append) {
313         BKE_reportf(reports,
314                     RPT_ERROR_INVALID_INPUT,
315                     "Can't append data-block '%s' of type '%s'",
316                     name,
317                     group);
318       }
319       else {
320         BKE_reportf(reports,
321                     RPT_ERROR_INVALID_INPUT,
322                     "Can't link data-block '%s' of type '%s'",
323                     name,
324                     group);
325       }
326     }
327     return false;
328   }
329
330   return true;
331 }
332
333 static int wm_link_append_exec(bContext *C, wmOperator *op)
334 {
335   Main *bmain = CTX_data_main(C);
336   Scene *scene = CTX_data_scene(C);
337   ViewLayer *view_layer = CTX_data_view_layer(C);
338   PropertyRNA *prop;
339   WMLinkAppendData *lapp_data;
340   char path[FILE_MAX_LIBEXTRA], root[FILE_MAXDIR], libname[FILE_MAX_LIBEXTRA], relname[FILE_MAX];
341   char *group, *name;
342   int totfiles = 0;
343
344   RNA_string_get(op->ptr, "filename", relname);
345   RNA_string_get(op->ptr, "directory", root);
346
347   BLI_join_dirfile(path, sizeof(path), root, relname);
348
349   /* test if we have a valid data */
350   if (!BLO_library_path_explode(path, libname, &group, &name)) {
351     BKE_reportf(op->reports, RPT_ERROR, "'%s': not a library", path);
352     return OPERATOR_CANCELLED;
353   }
354   else if (!group) {
355     BKE_reportf(op->reports, RPT_ERROR, "'%s': nothing indicated", path);
356     return OPERATOR_CANCELLED;
357   }
358   else if (BLI_path_cmp(BKE_main_blendfile_path(bmain), libname) == 0) {
359     BKE_reportf(op->reports, RPT_ERROR, "'%s': cannot use current file as library", path);
360     return OPERATOR_CANCELLED;
361   }
362
363   /* check if something is indicated for append/link */
364   prop = RNA_struct_find_property(op->ptr, "files");
365   if (prop) {
366     totfiles = RNA_property_collection_length(op->ptr, prop);
367     if (totfiles == 0) {
368       if (!name) {
369         BKE_reportf(op->reports, RPT_ERROR, "'%s': nothing indicated", path);
370         return OPERATOR_CANCELLED;
371       }
372     }
373   }
374   else if (!name) {
375     BKE_reportf(op->reports, RPT_ERROR, "'%s': nothing indicated", path);
376     return OPERATOR_CANCELLED;
377   }
378
379   short flag = wm_link_append_flag(op);
380   const bool do_append = (flag & FILE_LINK) == 0;
381
382   /* sanity checks for flag */
383   if (scene && scene->id.lib) {
384     BKE_reportf(op->reports,
385                 RPT_WARNING,
386                 "Scene '%s' is linked, instantiation of objects & groups is disabled",
387                 scene->id.name + 2);
388     flag &= ~FILE_GROUP_INSTANCE;
389     scene = NULL;
390   }
391
392   /* We need to add nothing from BLO_LibLinkFlags to flag here. */
393
394   /* from here down, no error returns */
395
396   if (view_layer && RNA_boolean_get(op->ptr, "autoselect")) {
397     BKE_view_layer_base_deselect_all(view_layer);
398   }
399
400   /* tag everything, all untagged data can be made local
401    * its also generally useful to know what is new
402    *
403    * take extra care BKE_main_id_flag_all(bmain, LIB_TAG_PRE_EXISTING, false) is called after! */
404   BKE_main_id_tag_all(bmain, LIB_TAG_PRE_EXISTING, true);
405
406   /* We define our working data...
407    * Note that here, each item 'uses' one library, and only one. */
408   lapp_data = wm_link_append_data_new(flag);
409   if (totfiles != 0) {
410     GHash *libraries = BLI_ghash_new(BLI_ghashutil_strhash_p, BLI_ghashutil_strcmp, __func__);
411     int lib_idx = 0;
412
413     RNA_BEGIN (op->ptr, itemptr, "files") {
414       RNA_string_get(&itemptr, "name", relname);
415
416       BLI_join_dirfile(path, sizeof(path), root, relname);
417
418       if (BLO_library_path_explode(path, libname, &group, &name)) {
419         if (!wm_link_append_item_poll(NULL, path, group, name, do_append)) {
420           continue;
421         }
422
423         if (!BLI_ghash_haskey(libraries, libname)) {
424           BLI_ghash_insert(libraries, BLI_strdup(libname), POINTER_FROM_INT(lib_idx));
425           lib_idx++;
426           wm_link_append_data_library_add(lapp_data, libname);
427         }
428       }
429     }
430     RNA_END;
431
432     RNA_BEGIN (op->ptr, itemptr, "files") {
433       RNA_string_get(&itemptr, "name", relname);
434
435       BLI_join_dirfile(path, sizeof(path), root, relname);
436
437       if (BLO_library_path_explode(path, libname, &group, &name)) {
438         WMLinkAppendDataItem *item;
439
440         if (!wm_link_append_item_poll(op->reports, path, group, name, do_append)) {
441           continue;
442         }
443
444         lib_idx = POINTER_AS_INT(BLI_ghash_lookup(libraries, libname));
445
446         item = wm_link_append_data_item_add(lapp_data, name, BKE_idcode_from_name(group), NULL);
447         BLI_BITMAP_ENABLE(item->libraries, lib_idx);
448       }
449     }
450     RNA_END;
451
452     BLI_ghash_free(libraries, MEM_freeN, NULL);
453   }
454   else {
455     WMLinkAppendDataItem *item;
456
457     wm_link_append_data_library_add(lapp_data, libname);
458     item = wm_link_append_data_item_add(lapp_data, name, BKE_idcode_from_name(group), NULL);
459     BLI_BITMAP_ENABLE(item->libraries, 0);
460   }
461
462   if (lapp_data->num_items == 0) {
463     /* Early out in case there is nothing to link. */
464     wm_link_append_data_free(lapp_data);
465     return OPERATOR_CANCELLED;
466   }
467
468   /* XXX We'd need re-entrant locking on Main for this to work... */
469   /* BKE_main_lock(bmain); */
470
471   wm_link_do(lapp_data, op->reports, bmain, scene, view_layer, CTX_wm_view3d(C));
472
473   /* BKE_main_unlock(bmain); */
474
475   /* mark all library linked objects to be updated */
476   BKE_main_lib_objects_recalc_all(bmain);
477   IMB_colormanagement_check_file_config(bmain);
478
479   /* append, rather than linking */
480   if (do_append) {
481     const bool set_fake = RNA_boolean_get(op->ptr, "set_fake");
482     const bool use_recursive = RNA_boolean_get(op->ptr, "use_recursive");
483
484     if (use_recursive) {
485       BKE_library_make_local(bmain, NULL, NULL, true, set_fake);
486     }
487     else {
488       LinkNode *itemlink;
489       GSet *done_libraries = BLI_gset_new_ex(
490           BLI_ghashutil_ptrhash, BLI_ghashutil_ptrcmp, __func__, lapp_data->num_libraries);
491
492       for (itemlink = lapp_data->items.list; itemlink; itemlink = itemlink->next) {
493         ID *new_id = ((WMLinkAppendDataItem *)(itemlink->link))->new_id;
494
495         if (new_id && !BLI_gset_haskey(done_libraries, new_id->lib)) {
496           BKE_library_make_local(bmain, new_id->lib, NULL, true, set_fake);
497           BLI_gset_insert(done_libraries, new_id->lib);
498         }
499       }
500
501       BLI_gset_free(done_libraries, NULL);
502     }
503   }
504
505   wm_link_append_data_free(lapp_data);
506
507   /* important we unset, otherwise these object wont
508    * link into other scenes from this blend file */
509   BKE_main_id_tag_all(bmain, LIB_TAG_PRE_EXISTING, false);
510
511   /* TODO(sergey): Use proper flag for tagging here. */
512
513   /* TODO (dalai): Temporary solution!
514    * Ideally we only need to tag the new objects themselves, not the scene. This way we'll avoid flush of
515    * collection properties to all objects and limit update to the particular object only.
516    * But afraid first we need to change collection evaluation in DEG according to depsgraph manifesto.
517    */
518   DEG_id_tag_update(&scene->id, 0);
519
520   /* recreate dependency graph to include new objects */
521   DEG_relations_tag_update(bmain);
522
523   /* XXX TODO: align G.lib with other directory storage (like last opened image etc...) */
524   BLI_strncpy(G.lib, root, FILE_MAX);
525
526   WM_event_add_notifier(C, NC_WINDOW, NULL);
527
528   return OPERATOR_FINISHED;
529 }
530
531 static void wm_link_append_properties_common(wmOperatorType *ot, bool is_link)
532 {
533   PropertyRNA *prop;
534
535   /* better not save _any_ settings for this operator */
536   /* properties */
537   prop = RNA_def_boolean(
538       ot->srna, "link", is_link, "Link", "Link the objects or data-blocks rather than appending");
539   RNA_def_property_flag(prop, PROP_SKIP_SAVE | PROP_HIDDEN);
540   prop = RNA_def_boolean(ot->srna, "autoselect", true, "Select", "Select new objects");
541   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
542   prop = RNA_def_boolean(ot->srna,
543                          "active_collection",
544                          true,
545                          "Active Collection",
546                          "Put new objects on the active collection");
547   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
548   prop = RNA_def_boolean(
549       ot->srna,
550       "instance_collections",
551       is_link,
552       "Instance Collections",
553       "Create instances for collections, rather than adding them directly to the scene");
554   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
555 }
556
557 void WM_OT_link(wmOperatorType *ot)
558 {
559   ot->name = "Link from Library";
560   ot->idname = "WM_OT_link";
561   ot->description = "Link from a Library .blend file";
562
563   ot->invoke = wm_link_append_invoke;
564   ot->exec = wm_link_append_exec;
565   ot->poll = wm_link_append_poll;
566
567   ot->flag |= OPTYPE_UNDO;
568
569   WM_operator_properties_filesel(ot,
570                                  FILE_TYPE_FOLDER | FILE_TYPE_BLENDER | FILE_TYPE_BLENDERLIB,
571                                  FILE_LOADLIB,
572                                  FILE_OPENFILE,
573                                  WM_FILESEL_FILEPATH | WM_FILESEL_DIRECTORY | WM_FILESEL_FILENAME |
574                                      WM_FILESEL_RELPATH | WM_FILESEL_FILES,
575                                  FILE_DEFAULTDISPLAY,
576                                  FILE_SORT_ALPHA);
577
578   wm_link_append_properties_common(ot, true);
579 }
580
581 void WM_OT_append(wmOperatorType *ot)
582 {
583   ot->name = "Append from Library";
584   ot->idname = "WM_OT_append";
585   ot->description = "Append from a Library .blend file";
586
587   ot->invoke = wm_link_append_invoke;
588   ot->exec = wm_link_append_exec;
589   ot->poll = wm_link_append_poll;
590
591   ot->flag |= OPTYPE_UNDO;
592
593   WM_operator_properties_filesel(ot,
594                                  FILE_TYPE_FOLDER | FILE_TYPE_BLENDER | FILE_TYPE_BLENDERLIB,
595                                  FILE_LOADLIB,
596                                  FILE_OPENFILE,
597                                  WM_FILESEL_FILEPATH | WM_FILESEL_DIRECTORY | WM_FILESEL_FILENAME |
598                                      WM_FILESEL_FILES,
599                                  FILE_DEFAULTDISPLAY,
600                                  FILE_SORT_ALPHA);
601
602   wm_link_append_properties_common(ot, false);
603   RNA_def_boolean(ot->srna,
604                   "set_fake",
605                   false,
606                   "Fake User",
607                   "Set Fake User for appended items (except Objects and Groups)");
608   RNA_def_boolean(
609       ot->srna,
610       "use_recursive",
611       true,
612       "Localize All",
613       "Localize all appended data, including those indirectly linked from other libraries");
614 }
615
616 /** \name Reload/relocate libraries.
617  *
618  * \{ */
619
620 static int wm_lib_relocate_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
621 {
622   Library *lib;
623   char lib_name[MAX_NAME];
624
625   RNA_string_get(op->ptr, "library", lib_name);
626   lib = (Library *)BKE_libblock_find_name(CTX_data_main(C), ID_LI, lib_name);
627
628   if (lib) {
629     if (lib->parent) {
630       BKE_reportf(op->reports,
631                   RPT_ERROR_INVALID_INPUT,
632                   "Cannot relocate indirectly linked library '%s'",
633                   lib->filepath);
634       return OPERATOR_CANCELLED;
635     }
636     RNA_string_set(op->ptr, "filepath", lib->filepath);
637
638     WM_event_add_fileselect(C, op);
639
640     return OPERATOR_RUNNING_MODAL;
641   }
642
643   return OPERATOR_CANCELLED;
644 }
645
646 static void lib_relocate_do(Main *bmain,
647                             Library *library,
648                             WMLinkAppendData *lapp_data,
649                             ReportList *reports,
650                             const bool do_reload)
651 {
652   ListBase *lbarray[MAX_LIBARRAY];
653   int lba_idx;
654
655   LinkNode *itemlink;
656   int item_idx;
657
658   /* Remove all IDs to be reloaded from Main. */
659   lba_idx = set_listbasepointers(bmain, lbarray);
660   while (lba_idx--) {
661     ID *id = lbarray[lba_idx]->first;
662     const short idcode = id ? GS(id->name) : 0;
663
664     if (!id || !BKE_idcode_is_linkable(idcode)) {
665       /* No need to reload non-linkable datatypes, those will get relinked with their 'users ID'. */
666       continue;
667     }
668
669     for (; id; id = id->next) {
670       if (id->lib == library) {
671         WMLinkAppendDataItem *item;
672
673         /* We remove it from current Main, and add it to items to link... */
674         /* Note that non-linkable IDs (like e.g. shapekeys) are also explicitly linked here... */
675         BLI_remlink(lbarray[lba_idx], id);
676         item = wm_link_append_data_item_add(lapp_data, id->name + 2, idcode, id);
677         BLI_bitmap_set_all(item->libraries, true, lapp_data->num_libraries);
678
679 #ifdef PRINT_DEBUG
680         printf("\tdatablock to seek for: %s\n", id->name);
681 #endif
682       }
683     }
684   }
685
686   if (lapp_data->num_items == 0) {
687     /* Early out in case there is nothing to do. */
688     return;
689   }
690
691   BKE_main_id_tag_all(bmain, LIB_TAG_PRE_EXISTING, true);
692
693   /* We do not want any instantiation here! */
694   wm_link_do(lapp_data, reports, bmain, NULL, NULL, NULL);
695
696   BKE_main_lock(bmain);
697
698   /* We add back old id to bmain.
699    * We need to do this in a first, separated loop, otherwise some of those may not be handled by
700    * ID remapping, which means they would still reference old data to be deleted... */
701   for (item_idx = 0, itemlink = lapp_data->items.list; itemlink;
702        item_idx++, itemlink = itemlink->next) {
703     WMLinkAppendDataItem *item = itemlink->link;
704     ID *old_id = item->customdata;
705
706     BLI_assert(old_id);
707     BLI_addtail(which_libbase(bmain, GS(old_id->name)), old_id);
708   }
709
710   /* Note that in reload case, we also want to replace indirect usages. */
711   const short remap_flags = ID_REMAP_SKIP_NEVER_NULL_USAGE |
712                             ID_REMAP_NO_INDIRECT_PROXY_DATA_USAGE |
713                             (do_reload ? 0 : ID_REMAP_SKIP_INDIRECT_USAGE);
714   for (item_idx = 0, itemlink = lapp_data->items.list; itemlink;
715        item_idx++, itemlink = itemlink->next) {
716     WMLinkAppendDataItem *item = itemlink->link;
717     ID *old_id = item->customdata;
718     ID *new_id = item->new_id;
719
720     BLI_assert(old_id);
721     if (do_reload) {
722       /* Since we asked for placeholders in case of missing IDs, we expect to always get a valid one. */
723       BLI_assert(new_id);
724     }
725     if (new_id) {
726 #ifdef PRINT_DEBUG
727       printf("before remap, old_id users: %d, new_id users: %d\n", old_id->us, new_id->us);
728 #endif
729       BKE_libblock_remap_locked(bmain, old_id, new_id, remap_flags);
730
731       if (old_id->flag & LIB_FAKEUSER) {
732         id_fake_user_clear(old_id);
733         id_fake_user_set(new_id);
734       }
735
736 #ifdef PRINT_DEBUG
737       printf("after remap, old_id users: %d, new_id users: %d\n", old_id->us, new_id->us);
738 #endif
739
740       /* In some cases, new_id might become direct link, remove parent of library in this case. */
741       if (new_id->lib->parent && (new_id->tag & LIB_TAG_INDIRECT) == 0) {
742         if (do_reload) {
743           BLI_assert(0); /* Should not happen in 'pure' reload case... */
744         }
745         new_id->lib->parent = NULL;
746       }
747     }
748
749     if (old_id->us > 0 && new_id && old_id->lib == new_id->lib) {
750       /* Note that this *should* not happen - but better be safe than sorry in this area, at least until we are
751        * 100% sure this cannot ever happen.
752        * Also, we can safely assume names were unique so far, so just replacing '.' by '~' should work,
753        * but this does not totally rules out the possibility of name collision. */
754       size_t len = strlen(old_id->name);
755       size_t dot_pos;
756       bool has_num = false;
757
758       for (dot_pos = len; dot_pos--;) {
759         char c = old_id->name[dot_pos];
760         if (c == '.') {
761           break;
762         }
763         else if (c < '0' || c > '9') {
764           has_num = false;
765           break;
766         }
767         has_num = true;
768       }
769
770       if (has_num) {
771         old_id->name[dot_pos] = '~';
772       }
773       else {
774         len = MIN2(len, MAX_ID_NAME - 7);
775         BLI_strncpy(&old_id->name[len], "~000", 7);
776       }
777
778       id_sort_by_name(which_libbase(bmain, GS(old_id->name)), old_id);
779
780       BKE_reportf(
781           reports,
782           RPT_WARNING,
783           "Lib Reload: Replacing all references to old data-block '%s' by reloaded one failed, "
784           "old one (%d remaining users) had to be kept and was renamed to '%s'",
785           new_id->name,
786           old_id->us,
787           old_id->name);
788     }
789   }
790
791   BKE_main_unlock(bmain);
792
793   for (item_idx = 0, itemlink = lapp_data->items.list; itemlink;
794        item_idx++, itemlink = itemlink->next) {
795     WMLinkAppendDataItem *item = itemlink->link;
796     ID *old_id = item->customdata;
797
798     if (old_id->us == 0) {
799       BKE_id_free(bmain, old_id);
800     }
801   }
802
803   /* Some datablocks can get reloaded/replaced 'silently' because they are not linkable (shape keys e.g.),
804    * so we need another loop here to clear old ones if possible. */
805   lba_idx = set_listbasepointers(bmain, lbarray);
806   while (lba_idx--) {
807     ID *id, *id_next;
808     for (id = lbarray[lba_idx]->first; id; id = id_next) {
809       id_next = id->next;
810       /* XXX That check may be a bit to generic/permissive? */
811       if (id->lib && (id->flag & LIB_TAG_PRE_EXISTING) && id->us == 0) {
812         BKE_id_free(bmain, id);
813       }
814     }
815   }
816
817   /* Get rid of no more used libraries... */
818   BKE_main_id_tag_idcode(bmain, ID_LI, LIB_TAG_DOIT, true);
819   lba_idx = set_listbasepointers(bmain, lbarray);
820   while (lba_idx--) {
821     ID *id;
822     for (id = lbarray[lba_idx]->first; id; id = id->next) {
823       if (id->lib) {
824         id->lib->id.tag &= ~LIB_TAG_DOIT;
825       }
826     }
827   }
828   Library *lib, *lib_next;
829   for (lib = which_libbase(bmain, ID_LI)->first; lib; lib = lib_next) {
830     lib_next = lib->id.next;
831     if (lib->id.tag & LIB_TAG_DOIT) {
832       id_us_clear_real(&lib->id);
833       if (lib->id.us == 0) {
834         BKE_id_free(bmain, (ID *)lib);
835       }
836     }
837   }
838
839   BKE_main_lib_objects_recalc_all(bmain);
840   IMB_colormanagement_check_file_config(bmain);
841
842   /* important we unset, otherwise these object wont
843    * link into other scenes from this blend file */
844   BKE_main_id_tag_all(bmain, LIB_TAG_PRE_EXISTING, false);
845
846   /* recreate dependency graph to include new objects */
847   DEG_relations_tag_update(bmain);
848 }
849
850 void WM_lib_reload(Library *lib, bContext *C, ReportList *reports)
851 {
852   if (!BLO_has_bfile_extension(lib->filepath)) {
853     BKE_reportf(reports, RPT_ERROR, "'%s' is not a valid library filepath", lib->filepath);
854     return;
855   }
856
857   if (!BLI_exists(lib->filepath)) {
858     BKE_reportf(reports,
859                 RPT_ERROR,
860                 "Trying to reload library '%s' from invalid path '%s'",
861                 lib->id.name,
862                 lib->filepath);
863     return;
864   }
865
866   WMLinkAppendData *lapp_data = wm_link_append_data_new(BLO_LIBLINK_USE_PLACEHOLDERS |
867                                                         BLO_LIBLINK_FORCE_INDIRECT);
868
869   wm_link_append_data_library_add(lapp_data, lib->filepath);
870
871   lib_relocate_do(CTX_data_main(C), lib, lapp_data, reports, true);
872
873   wm_link_append_data_free(lapp_data);
874
875   WM_event_add_notifier(C, NC_WINDOW, NULL);
876 }
877
878 static int wm_lib_relocate_exec_do(bContext *C, wmOperator *op, bool do_reload)
879 {
880   Library *lib;
881   char lib_name[MAX_NAME];
882
883   RNA_string_get(op->ptr, "library", lib_name);
884   lib = (Library *)BKE_libblock_find_name(CTX_data_main(C), ID_LI, lib_name);
885
886   if (lib) {
887     Main *bmain = CTX_data_main(C);
888     PropertyRNA *prop;
889     WMLinkAppendData *lapp_data;
890
891     char path[FILE_MAX], root[FILE_MAXDIR], libname[FILE_MAX], relname[FILE_MAX];
892     short flag = 0;
893
894     if (RNA_boolean_get(op->ptr, "relative_path")) {
895       flag |= FILE_RELPATH;
896     }
897
898     if (lib->parent && !do_reload) {
899       BKE_reportf(op->reports,
900                   RPT_ERROR_INVALID_INPUT,
901                   "Cannot relocate indirectly linked library '%s'",
902                   lib->filepath);
903       return OPERATOR_CANCELLED;
904     }
905
906     RNA_string_get(op->ptr, "directory", root);
907     RNA_string_get(op->ptr, "filename", libname);
908
909     if (!BLO_has_bfile_extension(libname)) {
910       BKE_report(op->reports, RPT_ERROR, "Not a library");
911       return OPERATOR_CANCELLED;
912     }
913
914     BLI_join_dirfile(path, sizeof(path), root, libname);
915
916     if (!BLI_exists(path)) {
917       BKE_reportf(op->reports,
918                   RPT_ERROR_INVALID_INPUT,
919                   "Trying to reload or relocate library '%s' to invalid path '%s'",
920                   lib->id.name,
921                   path);
922       return OPERATOR_CANCELLED;
923     }
924
925     if (BLI_path_cmp(lib->filepath, path) == 0) {
926 #ifdef PRINT_DEBUG
927       printf("We are supposed to reload '%s' lib (%d)...\n", lib->filepath, lib->id.us);
928 #endif
929
930       do_reload = true;
931
932       lapp_data = wm_link_append_data_new(flag);
933       wm_link_append_data_library_add(lapp_data, path);
934     }
935     else {
936       int totfiles = 0;
937
938 #ifdef PRINT_DEBUG
939       printf("We are supposed to relocate '%s' lib to new '%s' one...\n", lib->filepath, libname);
940 #endif
941
942       /* Check if something is indicated for relocate. */
943       prop = RNA_struct_find_property(op->ptr, "files");
944       if (prop) {
945         totfiles = RNA_property_collection_length(op->ptr, prop);
946         if (totfiles == 0) {
947           if (!libname[0]) {
948             BKE_report(op->reports, RPT_ERROR, "Nothing indicated");
949             return OPERATOR_CANCELLED;
950           }
951         }
952       }
953
954       lapp_data = wm_link_append_data_new(flag);
955
956       if (totfiles) {
957         RNA_BEGIN (op->ptr, itemptr, "files") {
958           RNA_string_get(&itemptr, "name", relname);
959
960           BLI_join_dirfile(path, sizeof(path), root, relname);
961
962           if (BLI_path_cmp(path, lib->filepath) == 0 || !BLO_has_bfile_extension(relname)) {
963             continue;
964           }
965
966 #ifdef PRINT_DEBUG
967           printf("\t candidate new lib to reload datablocks from: %s\n", path);
968 #endif
969           wm_link_append_data_library_add(lapp_data, path);
970         }
971         RNA_END;
972       }
973       else {
974 #ifdef PRINT_DEBUG
975         printf("\t candidate new lib to reload datablocks from: %s\n", path);
976 #endif
977         wm_link_append_data_library_add(lapp_data, path);
978       }
979     }
980
981     if (do_reload) {
982       lapp_data->flag |= BLO_LIBLINK_USE_PLACEHOLDERS | BLO_LIBLINK_FORCE_INDIRECT;
983     }
984
985     lib_relocate_do(bmain, lib, lapp_data, op->reports, do_reload);
986
987     wm_link_append_data_free(lapp_data);
988
989     /* XXX TODO: align G.lib with other directory storage (like last opened image etc...) */
990     BLI_strncpy(G.lib, root, FILE_MAX);
991
992     WM_event_add_notifier(C, NC_WINDOW, NULL);
993
994     return OPERATOR_FINISHED;
995   }
996
997   return OPERATOR_CANCELLED;
998 }
999
1000 static int wm_lib_relocate_exec(bContext *C, wmOperator *op)
1001 {
1002   return wm_lib_relocate_exec_do(C, op, false);
1003 }
1004
1005 void WM_OT_lib_relocate(wmOperatorType *ot)
1006 {
1007   PropertyRNA *prop;
1008
1009   ot->name = "Relocate Library";
1010   ot->idname = "WM_OT_lib_relocate";
1011   ot->description = "Relocate the given library to one or several others";
1012
1013   ot->invoke = wm_lib_relocate_invoke;
1014   ot->exec = wm_lib_relocate_exec;
1015
1016   ot->flag |= OPTYPE_UNDO;
1017
1018   prop = RNA_def_string(ot->srna, "library", NULL, MAX_NAME, "Library", "Library to relocate");
1019   RNA_def_property_flag(prop, PROP_HIDDEN);
1020
1021   WM_operator_properties_filesel(ot,
1022                                  FILE_TYPE_FOLDER | FILE_TYPE_BLENDER,
1023                                  FILE_BLENDER,
1024                                  FILE_OPENFILE,
1025                                  WM_FILESEL_FILEPATH | WM_FILESEL_DIRECTORY | WM_FILESEL_FILENAME |
1026                                      WM_FILESEL_FILES | WM_FILESEL_RELPATH,
1027                                  FILE_DEFAULTDISPLAY,
1028                                  FILE_SORT_ALPHA);
1029 }
1030
1031 static int wm_lib_reload_exec(bContext *C, wmOperator *op)
1032 {
1033   return wm_lib_relocate_exec_do(C, op, true);
1034 }
1035
1036 void WM_OT_lib_reload(wmOperatorType *ot)
1037 {
1038   PropertyRNA *prop;
1039
1040   ot->name = "Reload Library";
1041   ot->idname = "WM_OT_lib_reload";
1042   ot->description = "Reload the given library";
1043
1044   ot->exec = wm_lib_reload_exec;
1045
1046   ot->flag |= OPTYPE_UNDO;
1047
1048   prop = RNA_def_string(ot->srna, "library", NULL, MAX_NAME, "Library", "Library to reload");
1049   RNA_def_property_flag(prop, PROP_HIDDEN);
1050
1051   WM_operator_properties_filesel(ot,
1052                                  FILE_TYPE_FOLDER | FILE_TYPE_BLENDER,
1053                                  FILE_BLENDER,
1054                                  FILE_OPENFILE,
1055                                  WM_FILESEL_FILEPATH | WM_FILESEL_DIRECTORY | WM_FILESEL_FILENAME |
1056                                      WM_FILESEL_RELPATH,
1057                                  FILE_DEFAULTDISPLAY,
1058                                  FILE_SORT_ALPHA);
1059 }
1060
1061 /** \} */