Auto pack: don't show "No new files have been packed" on every .blend file save.
[blender.git] / source / blender / editors / space_info / info_ops.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_info/info_ops.c
28  *  \ingroup spinfo
29  */
30
31
32 #include <string.h>
33 #include <stdio.h>
34
35 #include "DNA_packedFile_types.h"
36 #include "DNA_space_types.h"
37 #include "DNA_windowmanager_types.h"
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_blenlib.h"
42 #include "BLI_math.h"
43 #include "BLI_utildefines.h"
44
45 #include "BLF_translation.h"
46
47 #include "BKE_bpath.h"
48 #include "BKE_context.h"
49 #include "BKE_global.h"
50 #include "BKE_image.h"
51 #include "BKE_library.h"
52 #include "BKE_main.h"
53 #include "BKE_packedFile.h"
54 #include "BKE_report.h"
55 #include "BKE_screen.h"
56
57
58 #include "WM_api.h"
59 #include "WM_types.h"
60
61
62 #include "UI_interface.h"
63 #include "UI_resources.h"
64
65 #include "IMB_imbuf_types.h"
66
67 #include "RNA_access.h"
68 #include "RNA_define.h"
69
70
71 #include "info_intern.h"
72
73 /********************* pack blend file libaries operator *********************/
74
75 static int pack_libraries_exec(bContext *C, wmOperator *op)
76 {
77         Main *bmain = CTX_data_main(C);
78
79         packLibraries(bmain, op->reports);
80
81         return OPERATOR_FINISHED;
82 }
83
84 void FILE_OT_pack_libraries(wmOperatorType *ot)
85 {
86         /* identifiers */
87         ot->name = "Pack Blender Libraries";
88         ot->idname = "FILE_OT_pack_libraries";
89         ot->description = "Pack all used Blender library files into the current .blend";
90         
91         /* api callbacks */
92         ot->exec = pack_libraries_exec;
93
94         /* flags */
95         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
96 }
97
98 static int unpack_libraries_exec(bContext *C, wmOperator *op)
99 {
100         Main *bmain = CTX_data_main(C);
101         
102         unpackLibraries(bmain, op->reports);
103         
104         return OPERATOR_FINISHED;
105 }
106
107 static int unpack_libraries_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
108 {
109         return WM_operator_confirm_message(C, op, "Unpack Blender Libraries - creates directories, all new paths should work");
110 }
111
112 void FILE_OT_unpack_libraries(wmOperatorType *ot)
113 {
114         /* identifiers */
115         ot->name = "Unpack Blender Libraries";
116         ot->idname = "FILE_OT_unpack_libraries";
117         ot->description = "Unpack all used Blender library files from this .blend file";
118         
119         /* api callbacks */
120         ot->invoke = unpack_libraries_invoke;
121         ot->exec = unpack_libraries_exec;
122         
123         /* flags */
124         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
125 }
126
127 /********************* toogle auto-pack operator *********************/
128
129 static int autopack_toggle_exec(bContext *C, wmOperator *op)
130 {
131         Main *bmain = CTX_data_main(C);
132
133         if (G.fileflags & G_AUTOPACK) {
134                 G.fileflags &= ~G_AUTOPACK;             
135         }
136         else {
137                 packAll(bmain, op->reports, true);
138                 G.fileflags |= G_AUTOPACK;
139         }
140         
141         return OPERATOR_FINISHED;
142 }
143
144 void FILE_OT_autopack_toggle(wmOperatorType *ot)
145 {
146         /* identifiers */
147         ot->name = "Automatically Pack Into .blend";
148         ot->idname = "FILE_OT_autopack_toggle";
149         ot->description = "Automatically pack all external files into the .blend file";
150         
151         /* api callbacks */
152         ot->exec = autopack_toggle_exec;
153         
154         /* flags */
155         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
156 }
157
158 /********************* pack all operator *********************/
159
160 static int pack_all_exec(bContext *C, wmOperator *op)
161 {
162         Main *bmain = CTX_data_main(C);
163         
164         packAll(bmain, op->reports, true);
165         G.fileflags |= G_AUTOPACK;
166         
167         return OPERATOR_FINISHED;
168 }
169
170 static int pack_all_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
171 {
172         Main *bmain = CTX_data_main(C);
173         Image *ima;
174         ImBuf *ibuf;
175         
176         // first check for dirty images
177         for (ima = bmain->image.first; ima; ima = ima->id.next) {
178                 if (BKE_image_has_loaded_ibuf(ima)) { /* XXX FIX */
179                         ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
180                         
181                         if (ibuf && (ibuf->userflags & IB_BITMAPDIRTY)) {
182                                 BKE_image_release_ibuf(ima, ibuf, NULL);
183                                 break;
184                         }
185                         
186                         BKE_image_release_ibuf(ima, ibuf, NULL);
187                 }
188         }
189         
190         if (ima) {
191                 return WM_operator_confirm_message(C, op, "Some images are painted on. These changes will be lost. Continue?");
192         }
193         
194         return pack_all_exec(C, op);
195 }
196
197 void FILE_OT_pack_all(wmOperatorType *ot)
198 {
199         /* identifiers */
200         ot->name = "Pack All Into .blend";
201         ot->idname = "FILE_OT_pack_all";
202         ot->description = "Pack all used external files into the .blend";
203         
204         /* api callbacks */
205         ot->exec = pack_all_exec;
206         ot->invoke = pack_all_invoke;
207         
208         /* flags */
209         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
210 }
211
212
213 /********************* unpack all operator *********************/
214
215 static const EnumPropertyItem unpack_all_method_items[] = {
216         {PF_USE_LOCAL, "USE_LOCAL", 0, "Use files in current directory (create when necessary)", ""},
217         {PF_WRITE_LOCAL, "WRITE_LOCAL", 0, "Write files to current directory (overwrite existing files)", ""},
218         {PF_USE_ORIGINAL, "USE_ORIGINAL", 0, "Use files in original location (create when necessary)", ""},
219         {PF_WRITE_ORIGINAL, "WRITE_ORIGINAL", 0, "Write files to original location (overwrite existing files)", ""},
220         {PF_KEEP, "KEEP", 0, "Disable Auto-pack, keep all packed files", ""},
221         /* {PF_ASK, "ASK", 0, "Ask for each file", ""}, */
222         {0, NULL, 0, NULL, NULL}};
223
224 static int unpack_all_exec(bContext *C, wmOperator *op)
225 {
226         Main *bmain = CTX_data_main(C);
227         int method = RNA_enum_get(op->ptr, "method");
228
229         if (method != PF_KEEP) unpackAll(bmain, op->reports, method);  /* XXX PF_ASK can't work here */
230         G.fileflags &= ~G_AUTOPACK;
231
232         return OPERATOR_FINISHED;
233 }
234
235 static int unpack_all_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
236 {
237         Main *bmain = CTX_data_main(C);
238         uiPopupMenu *pup;
239         uiLayout *layout;
240         char title[64];
241         int count = 0;
242         
243         count = countPackedFiles(bmain);
244         
245         if (!count) {
246                 BKE_report(op->reports, RPT_WARNING, "No packed files to unpack");
247                 G.fileflags &= ~G_AUTOPACK;
248                 return OPERATOR_CANCELLED;
249         }
250
251         if (count == 1)
252                 strcpy(title, IFACE_("Unpack 1 File"));
253         else
254                 BLI_snprintf(title, sizeof(title), IFACE_("Unpack %d Files"), count);
255         
256         pup = UI_popup_menu_begin(C, title, ICON_NONE);
257         layout = UI_popup_menu_layout(pup);
258
259         uiLayoutSetOperatorContext(layout, WM_OP_EXEC_DEFAULT);
260         uiItemsEnumO(layout, "FILE_OT_unpack_all", "method");
261
262         UI_popup_menu_end(C, pup);
263
264         return OPERATOR_INTERFACE;
265 }
266
267 void FILE_OT_unpack_all(wmOperatorType *ot)
268 {
269         /* identifiers */
270         ot->name = "Unpack All Into Files";
271         ot->idname = "FILE_OT_unpack_all";
272         ot->description = "Unpack all files packed into this .blend to external ones";
273         
274         /* api callbacks */
275         ot->exec = unpack_all_exec;
276         ot->invoke = unpack_all_invoke;
277
278         /* flags */
279         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
280
281         /* properties */
282         RNA_def_enum(ot->srna, "method", unpack_all_method_items, PF_USE_LOCAL, "Method", "How to unpack");
283 }
284
285 /********************* unpack single item operator *********************/
286
287 static const EnumPropertyItem unpack_item_method_items[] = {
288         {PF_USE_LOCAL, "USE_LOCAL", 0, "Use file from current directory (create when necessary)", ""},
289         {PF_WRITE_LOCAL, "WRITE_LOCAL", 0, "Write file to current directory (overwrite existing file)", ""},
290         {PF_USE_ORIGINAL, "USE_ORIGINAL", 0, "Use file in original location (create when necessary)", ""},
291         {PF_WRITE_ORIGINAL, "WRITE_ORIGINAL", 0, "Write file to original location (overwrite existing file)", ""},
292         /* {PF_ASK, "ASK", 0, "Ask for each file", ""}, */
293         {0, NULL, 0, NULL, NULL}};
294
295
296 static int unpack_item_exec(bContext *C, wmOperator *op)
297 {
298         Main *bmain = CTX_data_main(C);
299         ID *id;
300         char idname[MAX_ID_NAME - 2];
301         int type = RNA_int_get(op->ptr, "id_type");
302         int method = RNA_enum_get(op->ptr, "method");
303
304         RNA_string_get(op->ptr, "id_name", idname);
305         id = BKE_libblock_find_name(type, idname);
306
307         if (id == NULL) {
308                 BKE_report(op->reports, RPT_WARNING, "No packed file");
309                 return OPERATOR_CANCELLED;
310         }
311         
312         if (method != PF_KEEP)
313                 BKE_unpack_id(bmain, id, op->reports, method);  /* XXX PF_ASK can't work here */
314         
315         G.fileflags &= ~G_AUTOPACK;
316         
317         return OPERATOR_FINISHED;
318 }
319
320 static int unpack_item_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
321 {
322         uiPopupMenu *pup;
323         uiLayout *layout;
324         
325         pup = UI_popup_menu_begin(C, IFACE_("Unpack"), ICON_NONE);
326         layout = UI_popup_menu_layout(pup);
327         
328         uiLayoutSetOperatorContext(layout, WM_OP_EXEC_DEFAULT);
329         uiItemsFullEnumO(layout, op->type->idname, "method", op->ptr->data, WM_OP_EXEC_REGION_WIN, 0);
330         
331         UI_popup_menu_end(C, pup);
332         
333         return OPERATOR_INTERFACE;
334 }
335
336 void FILE_OT_unpack_item(wmOperatorType *ot)
337 {
338         /* identifiers */
339         ot->name = "Unpack Item";
340         ot->idname = "FILE_OT_unpack_item";
341         ot->description = "Unpack this file to an external file";
342         
343         /* api callbacks */
344         ot->exec = unpack_item_exec;
345         ot->invoke = unpack_item_invoke;
346         
347         /* flags */
348         ot->flag = OPTYPE_UNDO;
349         
350         /* properties */
351         RNA_def_enum(ot->srna, "method", unpack_item_method_items, PF_USE_LOCAL, "Method", "How to unpack");
352         RNA_def_string(ot->srna, "id_name", NULL, BKE_ST_MAXNAME, "ID name", "Name of ID block to unpack");
353         RNA_def_int(ot->srna, "id_type", ID_IM, 0, INT_MAX, "ID Type", "Identifier type of ID block", 0, INT_MAX);
354 }
355
356
357 /********************* make paths relative operator *********************/
358
359 static int make_paths_relative_exec(bContext *C, wmOperator *op)
360 {
361         Main *bmain = CTX_data_main(C);
362
363         if (!G.relbase_valid) {
364                 BKE_report(op->reports, RPT_WARNING, "Cannot set relative paths with an unsaved blend file");
365                 return OPERATOR_CANCELLED;
366         }
367
368         BKE_bpath_relative_convert(bmain, bmain->name, op->reports);
369
370         /* redraw everything so any changed paths register */
371         WM_main_add_notifier(NC_WINDOW, NULL);
372
373         return OPERATOR_FINISHED;
374 }
375
376 void FILE_OT_make_paths_relative(wmOperatorType *ot)
377 {
378         /* identifiers */
379         ot->name = "Make All Paths Relative";
380         ot->idname = "FILE_OT_make_paths_relative";
381         ot->description = "Make all paths to external files relative to current .blend";
382         
383         /* api callbacks */
384         ot->exec = make_paths_relative_exec;
385
386         /* flags */
387         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
388 }
389
390 /********************* make paths absolute operator *********************/
391
392 static int make_paths_absolute_exec(bContext *C, wmOperator *op)
393 {
394         Main *bmain = CTX_data_main(C);
395
396         if (!G.relbase_valid) {
397                 BKE_report(op->reports, RPT_WARNING, "Cannot set absolute paths with an unsaved blend file");
398                 return OPERATOR_CANCELLED;
399         }
400
401         BKE_bpath_absolute_convert(bmain, bmain->name, op->reports);
402
403         /* redraw everything so any changed paths register */
404         WM_main_add_notifier(NC_WINDOW, NULL);
405
406         return OPERATOR_FINISHED;
407 }
408
409 void FILE_OT_make_paths_absolute(wmOperatorType *ot)
410 {
411         /* identifiers */
412         ot->name = "Make All Paths Absolute";
413         ot->idname = "FILE_OT_make_paths_absolute";
414         ot->description = "Make all paths to external files absolute";
415         
416         /* api callbacks */
417         ot->exec = make_paths_absolute_exec;
418
419         /* flags */
420         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
421 }
422
423 /********************* report missing files operator *********************/
424
425 static int report_missing_files_exec(bContext *C, wmOperator *op)
426 {
427         Main *bmain = CTX_data_main(C);
428
429         /* run the missing file check */
430         BKE_bpath_missing_files_check(bmain, op->reports);
431         
432         return OPERATOR_FINISHED;
433 }
434
435 void FILE_OT_report_missing_files(wmOperatorType *ot)
436 {
437         /* identifiers */
438         ot->name = "Report Missing Files";
439         ot->idname = "FILE_OT_report_missing_files";
440         ot->description = "Report all missing external files";
441         
442         /* api callbacks */
443         ot->exec = report_missing_files_exec;
444
445         /* flags */
446         ot->flag = 0; /* only reports so no need to undo/register */
447 }
448
449 /********************* find missing files operator *********************/
450
451 static int find_missing_files_exec(bContext *C, wmOperator *op)
452 {
453         Main *bmain = CTX_data_main(C);
454         const char *searchpath = RNA_string_get_alloc(op->ptr, "directory", NULL, 0);
455         const bool find_all = RNA_boolean_get(op->ptr, "find_all");
456
457         BKE_bpath_missing_files_find(bmain, searchpath, op->reports, find_all);
458         MEM_freeN((void *)searchpath);
459
460         return OPERATOR_FINISHED;
461 }
462
463 static int find_missing_files_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
464 {
465         /* XXX file open button text "Find Missing Files" */
466         WM_event_add_fileselect(C, op); 
467         return OPERATOR_RUNNING_MODAL;
468 }
469
470 void FILE_OT_find_missing_files(wmOperatorType *ot)
471 {
472         /* identifiers */
473         ot->name = "Find Missing Files";
474         ot->idname = "FILE_OT_find_missing_files";
475         ot->description = "Try to find missing external files";
476         
477         /* api callbacks */
478         ot->exec = find_missing_files_exec;
479         ot->invoke = find_missing_files_invoke;
480
481         /* flags */
482         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
483
484         /* properties */
485         RNA_def_boolean(ot->srna, "find_all", false, "Find All", "Find all files in the search path (not just missing)");
486
487         WM_operator_properties_filesel(ot, 0, FILE_SPECIAL, FILE_OPENFILE,
488                                        WM_FILESEL_DIRECTORY, FILE_DEFAULTDISPLAY);
489 }
490
491 /********************* report box operator *********************/
492
493 /* Hard to decide whether to keep this as an operator, 
494  * or turn it into a hardcoded ui control feature, 
495  * handling TIMER events for all regions in interface_handlers.c
496  * Not sure how good that is to be accessing UI data from 
497  * inactive regions, so use this for now. --matt
498  */
499
500 #define INFO_TIMEOUT        5.0f
501 #define INFO_COLOR_TIMEOUT  3.0f
502 #define ERROR_TIMEOUT       10.0f
503 #define ERROR_COLOR_TIMEOUT 6.0f
504 #define COLLAPSE_TIMEOUT    0.25f
505 static int update_reports_display_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
506 {
507         wmWindowManager *wm = CTX_wm_manager(C);
508         ReportList *reports = CTX_wm_reports(C);
509         Report *report;
510         ReportTimerInfo *rti;
511         float progress = 0.0, color_progress = 0.0;
512         float neutral_col[3] = {0.35, 0.35, 0.35};
513         float neutral_gray = 0.6;
514         float timeout = 0.0, color_timeout = 0.0;
515         int send_note = 0;
516         
517         /* escape if not our timer */
518         if ((reports->reporttimer == NULL) ||
519             (reports->reporttimer != event->customdata) ||
520             ((report = BKE_reports_last_displayable(reports)) == NULL) /* may have been deleted */
521             )
522         {
523                 return OPERATOR_PASS_THROUGH;
524         }
525
526         rti = (ReportTimerInfo *)reports->reporttimer->customdata;
527         
528         timeout = (report->type & RPT_ERROR_ALL) ? ERROR_TIMEOUT : INFO_TIMEOUT;
529         color_timeout = (report->type & RPT_ERROR_ALL) ? ERROR_COLOR_TIMEOUT : INFO_COLOR_TIMEOUT;
530         
531         /* clear the report display after timeout */
532         if ((float)reports->reporttimer->duration > timeout) {
533                 WM_event_remove_timer(wm, NULL, reports->reporttimer);
534                 reports->reporttimer = NULL;
535                 
536                 WM_event_add_notifier(C, NC_SPACE | ND_SPACE_INFO, NULL);
537                 
538                 return (OPERATOR_FINISHED | OPERATOR_PASS_THROUGH);
539         }
540
541         if (rti->widthfac == 0.0f) {
542                 /* initialize colors based on report type */
543                 if (report->type & RPT_ERROR_ALL) {
544                         rti->col[0] = 1.0;
545                         rti->col[1] = 0.2;
546                         rti->col[2] = 0.0;
547                 }
548                 else if (report->type & RPT_WARNING_ALL) {
549                         rti->col[0] = 1.0;
550                         rti->col[1] = 1.0;
551                         rti->col[2] = 0.0;
552                 }
553                 else if (report->type & RPT_INFO_ALL) {
554                         rti->col[0] = 0.3;
555                         rti->col[1] = 0.45;
556                         rti->col[2] = 0.7;
557                 }
558                 rti->grayscale = 0.75;
559                 rti->widthfac = 1.0;
560         }
561         
562         progress = (float)reports->reporttimer->duration / timeout;
563         color_progress = (float)reports->reporttimer->duration / color_timeout;
564         
565         /* save us from too many draws */
566         if (color_progress <= 1.0f) {
567                 send_note = 1;
568                 
569                 /* fade colors out sharply according to progress through fade-out duration */
570                 interp_v3_v3v3(rti->col, rti->col, neutral_col, color_progress);
571                 rti->grayscale = interpf(neutral_gray, rti->grayscale, color_progress);
572         }
573
574         /* collapse report at end of timeout */
575         if (progress * timeout > timeout - COLLAPSE_TIMEOUT) {
576                 rti->widthfac = (progress * timeout - (timeout - COLLAPSE_TIMEOUT)) / COLLAPSE_TIMEOUT;
577                 rti->widthfac = 1.0f - rti->widthfac;
578                 send_note = 1;
579         }
580         
581         if (send_note) {
582                 WM_event_add_notifier(C, NC_SPACE | ND_SPACE_INFO, NULL);
583         }
584         
585         return (OPERATOR_FINISHED | OPERATOR_PASS_THROUGH);
586 }
587
588 void INFO_OT_reports_display_update(wmOperatorType *ot)
589 {
590         /* identifiers */
591         ot->name = "Update Reports Display";
592         ot->idname = "INFO_OT_reports_display_update";
593         ot->description = "Update the display of reports in Blender UI (internal use)";
594         
595         /* api callbacks */
596         ot->invoke = update_reports_display_invoke;
597         
598         /* flags */
599         ot->flag = 0;
600         
601         /* properties */
602 }
603
604 /* report operators */