1 /* 2 Bacula(R) - The Network Backup Solution 3 4 Copyright (C) 2000-2020 Kern Sibbald 5 6 The original author of Bacula is Kern Sibbald, with contributions 7 from many others, a complete list can be found in the file AUTHORS. 8 9 You may use this file and others of this release according to the 10 license defined in the LICENSE file, which includes the Affero General 11 Public License, v3.0 ("AGPLv3") and some additional permissions and 12 terms pursuant to its AGPLv3 Section 7. 13 14 This notice must be preserved when any source code is 15 conveyed and/or propagated. 16 17 Bacula(R) is a registered trademark of Kern Sibbald. 18 */ 19 /* 20 * Director external function prototypes 21 */ 22 23 /* admin.c */ 24 extern bool do_admin_init(JCR *jcr); 25 extern bool do_admin(JCR *jcr); 26 extern void admin_cleanup(JCR *jcr, int TermCode); 27 28 29 /* authenticate.c */ 30 extern bool authenticate_storage_daemon(JCR *jcr, STORE *store); 31 extern int authenticate_file_daemon(JCR *jcr); 32 extern int authenticate_user_agent(UAContext *ua); 33 34 /* autoprune.c */ 35 extern void do_autoprune(JCR *jcr); 36 extern void prune_volumes(JCR *jcr, bool InChanger, MEDIA_DBR *mr, 37 STORE *store); 38 39 /* autorecycle.c */ 40 extern bool recycle_oldest_purged_volume(JCR *jcr, bool InChanger, 41 MEDIA_DBR *mr, STORE *store); 42 43 extern int recycle_volume(JCR *jcr, MEDIA_DBR *mr); 44 extern bool find_recycled_volume(JCR *jcr, bool InChanger, 45 MEDIA_DBR *mr, STORE *store); 46 47 /* backup.c */ 48 extern int wait_for_job_termination(JCR *jcr, int timeout=0); 49 extern bool do_backup_init(JCR *jcr); 50 extern bool do_backup(JCR *jcr); 51 extern void backup_cleanup(JCR *jcr, int TermCode); 52 extern void update_bootstrap_file(JCR *jcr); 53 extern bool send_accurate_current_files(JCR *jcr); 54 extern char *get_storage_address(CLIENT *cli, STORE *store); 55 extern bool run_storage_and_start_message_thread(JCR *jcr, BSOCK *sd); 56 extern bool send_client_addr_to_sd(JCR *jcr); 57 extern bool send_store_addr_to_fd(JCR *jcr, STORE *store, 58 char *store_address, uint32_t store_port); 59 60 /* vbackup.c */ 61 extern bool do_vbackup_init(JCR *jcr); 62 extern bool do_vbackup(JCR *jcr); 63 extern void vbackup_cleanup(JCR *jcr, int TermCode); 64 65 66 /* bsr.c */ 67 RBSR *new_bsr(); 68 rblist *create_bsr_list(uint32_t JobId, int findex, int findex2); 69 void free_bsr(rblist *bsr_list); 70 bool complete_bsr(UAContext *ua, rblist *bsr_list); 71 uint32_t write_bsr_file(UAContext *ua, RESTORE_CTX &rx); 72 void display_bsr_info(UAContext *ua, RESTORE_CTX &rx); 73 void add_findex(rblist *bsr_list, uint32_t JobId, int32_t findex); 74 void add_findex_all(rblist *bsr_list, uint32_t JobId, const char *fileregex); 75 RBSR_FINDEX *new_findex(); 76 void make_unique_restore_filename(UAContext *ua, POOLMEM **fname); 77 void print_bsr(UAContext *ua, RESTORE_CTX &rx); 78 void scan_bsr(JCR *jcr); 79 80 81 /* catreq.c */ 82 extern void catalog_request(JCR *jcr, BSOCK *bs); 83 extern void catalog_update(JCR *jcr, BSOCK *bs); 84 extern bool despool_attributes_from_file(JCR *jcr, const char *file); 85 extern void remove_dummy_jobmedia_records(JCR *jcr); 86 87 /* dird_conf.c */ 88 extern const char *level_to_static_str(int level); 89 extern char *level_to_str(char *buf, int len, int level); 90 extern "C" char *job_code_callback_director(JCR *jcr, const char*, char *, int); 91 extern char *get_client_address(JCR *jcr, CLIENT *client, POOLMEM *&buf); 92 93 /* expand.c */ 94 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp); 95 96 /* fd_cmds.c */ 97 extern int connect_to_file_daemon(JCR *jcr, int retry_interval, 98 int max_retry_time, int verbose); 99 extern bool send_ls_fileset(JCR *jcr, const char *path); 100 extern bool send_ls_plugin_fileset(JCR *jcr, const char *plugin, const char *path); 101 extern bool send_include_list(JCR *jcr); 102 extern bool send_exclude_list(JCR *jcr); 103 extern bool send_level_command(JCR *jcr); 104 extern bool send_bwlimit(JCR *jcr, const char *Job); 105 extern bool send_restore_file_list(JCR *jcr); 106 extern int get_attributes_and_put_in_catalog(JCR *jcr); 107 extern void get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId); 108 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname, 109 char *link, char *attr, int stream); 110 extern void get_level_since_time(JCR *jcr, char *since, int since_len); 111 extern int send_runscripts_commands(JCR *jcr); 112 extern bool send_restore_objects(JCR *jcr); 113 extern bool send_component_info(JCR *jcr); 114 115 /* getmsg.c */ 116 enum e_prtmsg { 117 DISPLAY_ERROR, 118 NO_DISPLAY 119 }; 120 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg); 121 122 /* job.c */ 123 extern bool allow_duplicate_job(JCR *jcr); 124 extern void set_jcr_defaults(JCR *jcr, JOB *job); 125 extern void create_unique_job_name(JCR *jcr, const char *base_name); 126 extern void update_job_end_record(JCR *jcr); 127 extern bool get_or_create_client_record(JCR *jcr); 128 extern bool get_or_create_fileset_record(JCR *jcr); 129 extern DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name); 130 extern void apply_pool_overrides(JCR *jcr); 131 extern bool apply_wstorage_overrides(JCR *jcr, POOL *original_pool); 132 extern JobId_t run_job(JCR *jcr); 133 extern JobId_t resume_job(JCR *jcr, JOB_DBR *jr); 134 extern bool cancel_job(UAContext *ua, JCR *jcr, int wait, bool cancel=true); 135 extern int cancel_inactive_job(UAContext *ua); 136 extern void get_job_storage(USTORE *store, JOB *job, RUN *run); 137 extern void init_jcr_job_record(JCR *jcr); 138 extern void update_job_end(JCR *jcr, int TermCode); 139 extern void copy_rwstorage(JCR *jcr, alist *storage, const char *where); 140 extern void set_rwstorage(JCR *jcr, USTORE *store); 141 extern void free_rwstorage(JCR *jcr); 142 extern void copy_wstorage(JCR *jcr, alist *storage, const char *where); 143 extern void set_wstorage(JCR *jcr, USTORE *store); 144 extern void free_wstorage(JCR *jcr); 145 extern void copy_rstorage(JCR *jcr, alist *storage, const char *where); 146 extern void set_rstorage(JCR *jcr, USTORE *store); 147 extern void free_rstorage(JCR *jcr); 148 extern bool setup_job(JCR *jcr); 149 extern void create_clones(JCR *jcr); 150 extern int create_restore_bootstrap_file(JCR *jcr); 151 extern int create_restore_bootstrap_file(JCR *jcr, JobId_t jobid, int findex1, int findex2); 152 extern void dird_free_jcr(JCR *jcr); 153 extern void dird_free_jcr_pointers(JCR *jcr); 154 extern void cancel_storage_daemon_job(JCR *jcr); 155 extern bool run_console_command(JCR *jcr, const char *cmd); 156 extern void sd_msg_thread_send_signal(JCR *jcr, int sig); 157 void terminate_sd_msg_chan_thread(JCR *jcr); 158 bool flush_file_records(JCR *jcr); 159 160 /* jobq.c */ 161 extern bool inc_read_store(JCR *jcr); 162 extern void dec_read_store(JCR *jcr); 163 164 /* mac.c */ 165 extern bool do_mac(JCR *jcr); 166 extern bool do_mac_init(JCR *jcr); 167 extern void mac_cleanup(JCR *jcr, int TermCode, int writeTermCode); 168 extern bool set_mac_wstorage(UAContext *ua, JCR *jcr, POOL *pool, 169 POOL *next_pool, const char *source); 170 171 172 /* mountreq.c */ 173 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf); 174 175 /* msgchan.c */ 176 extern BSOCK *open_sd_bsock(UAContext *ua); 177 extern void close_sd_bsock(UAContext *ua); 178 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval, 179 int max_retry_time, int verbose); 180 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore, 181 bool send_bsr=false); 182 extern bool start_storage_daemon_message_thread(JCR *jcr); 183 extern int bget_dirmsg(BSOCK *bs); 184 extern void wait_for_storage_daemon_termination(JCR *jcr); 185 extern bool send_bootstrap_file(JCR *jcr, BSOCK *sd); 186 187 /* next_vol.c */ 188 bool check_max_pool_bytes(POOL_DBR *pr); 189 bool use_max_pool_bytes(JCR *jcr); 190 bool has_quota_reached(JCR *jcr, POOL_DBR *pr); 191 bool has_quota_reached(JCR *jcr, MEDIA_DBR *mr); 192 bool has_quota_reached(JCR *jcr); 193 void set_storageid_in_mr(STORE *store, MEDIA_DBR *mr); 194 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index, 195 bool create, bool purge, POOL_MEM &errmsg); 196 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr); 197 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason); 198 bool get_scratch_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr, 199 STORE *store); 200 201 /* newvol.c */ 202 bool newVolume(JCR *jcr, MEDIA_DBR *mr, STORE *store, POOL_MEM &errmsg); 203 204 /* restore.c */ 205 extern bool do_restore(JCR *jcr); 206 extern bool do_restore_init(JCR *jcr); 207 extern void restore_cleanup(JCR *jcr, int TermCode); 208 209 210 /* ua_acl.c */ 211 bool acl_access_ok(UAContext *ua, int acl, const char *item); 212 bool acl_access_ok(UAContext *ua, int acl, const char *item, int len); 213 bool have_restricted_acl(UAContext *ua, int acl); 214 bool acl_access_client_ok(UAContext *ua, const char *name, int32_t jobtype); 215 bool acl_access_console_ok(UAContext *ua, const char *name); 216 217 /* ua_cmds.c */ 218 bool get_uid_gid_from_acl(UAContext *ua, alist **uid, alist **gid, alist **dir); 219 bool do_a_command(UAContext *ua); 220 bool do_a_dot_command(UAContext *ua); 221 int qmessagescmd(UAContext *ua, const char *cmd); 222 bool open_new_client_db(UAContext *ua); 223 bool open_client_db(UAContext *ua); 224 bool open_db(UAContext *ua); 225 void close_db(UAContext *ua); 226 int cloud_volumes_cmd(UAContext *ua, const char *cmd, const char *mode); 227 enum e_pool_op { 228 POOL_OP_UPDATE, 229 POOL_OP_CREATE 230 }; 231 int create_pool(JCR *jcr, BDB *db, POOL *pool, e_pool_op op); 232 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr); 233 bool set_pooldbr_references(JCR *jcr, BDB *db, POOL_DBR *pr, POOL *pool); 234 void set_pooldbr_from_poolres(POOL_DBR *pr, POOL *pool, e_pool_op op); 235 int update_pool_references(JCR *jcr, BDB *db, POOL *pool); 236 237 /* ua_input.c */ 238 bool get_cmd(UAContext *ua, const char *prompt, bool subprompt=false); 239 bool get_selection_list(UAContext *ua, sellist &sl, const char *prompt, bool subprompt=false); 240 bool get_pint(UAContext *ua, const char *prompt); 241 bool get_yesno(UAContext *ua, const char *prompt); 242 bool is_yesno(char *val, int *ret); 243 int get_enabled(UAContext *ua, const char *val); 244 void parse_ua_args(UAContext *ua); 245 bool is_comment_legal(UAContext *ua, const char *name); 246 247 /* ua_label.c */ 248 bool is_volume_name_legal(UAContext *ua, const char *name); 249 int get_num_drives_from_SD(UAContext *ua); 250 void update_slots(UAContext *ua); 251 252 /* ua_update.c */ 253 void update_vol_pool(UAContext *ua, char *val, MEDIA_DBR *mr, POOL_DBR *opr); 254 255 /* ua_output.c */ 256 void prtit(void *ctx, const char *msg); 257 bool complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool); 258 RUN *find_next_run(RUN *run, JOB *job, utime_t &runtime, int ndays); 259 bool acl_access_jobid_ok(UAContext *ua, const char *jobids); 260 261 /* ua_restore.c */ 262 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType); 263 bool insert_table_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *table); 264 void new_rx(RESTORE_CTX *rx); 265 void free_rx(RESTORE_CTX *rx); 266 267 /* ua_server.c */ 268 void bsendmsg(void *ua_ctx, const char *fmt, ...); 269 void berrormsg(void *ua_ctx, const char *fmt, ...); 270 void bwarningmsg(void *ua_ctx, const char *fmt, ...); 271 void binfomsg(void *ua_ctx, const char *fmt, ...); 272 UAContext *new_ua_context(JCR *jcr); 273 JCR *new_control_jcr(const char *base_name, int job_type); 274 void free_ua_context(UAContext *ua); 275 276 /* ua_select.c */ 277 STORE *select_storage_resource(UAContext *ua, bool unique=false); 278 JOB *select_job_resource(UAContext *ua); 279 JOB *select_enable_disable_job_resource(UAContext *ua, bool enable); 280 JOB *select_restore_job_resource(UAContext *ua); 281 CLIENT *select_enable_disable_client_resource(UAContext *ua, bool enable); 282 CLIENT *select_client_resource(UAContext *ua, int32_t jobtype); 283 FILESET *select_fileset_resource(UAContext *ua); 284 SCHED *select_enable_disable_schedule_resource(UAContext *ua, bool enable); 285 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr); 286 int select_media_dbr(UAContext *ua, MEDIA_DBR *mr); 287 bool select_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool"); 288 bool select_client_dbr(UAContext *ua, CLIENT_DBR *cr, int32_t jobtype); 289 290 void start_prompt(UAContext *ua, const char *msg); 291 void add_prompt(UAContext *ua, const char *prompt, char *unique=NULL); 292 int do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt); 293 int do_alist_prompt(UAContext *ua, const char *automsg, const char *msg, 294 alist *selected); 295 CAT *get_catalog_resource(UAContext *ua); 296 STORE *get_storage_resource(UAContext *ua, bool use_default, bool unique=false); 297 int get_storage_drive(UAContext *ua, STORE *store); 298 int get_storage_slot(UAContext *ua, STORE *store); 299 int get_media_type(UAContext *ua, char *MediaType, int max_media); 300 bool get_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool"); 301 bool get_client_dbr(UAContext *ua, CLIENT_DBR *cr, int32_t jobtype); 302 POOL *get_pool_resource(UAContext *ua); 303 JOB *get_restore_job(UAContext *ua); 304 POOL *select_pool_resource(UAContext *ua); 305 int select_running_jobs(UAContext *ua, alist *jcrs, const char *reason); 306 CLIENT *get_client_resource(UAContext *ua, int32_t jobtype); 307 int get_job_dbr(UAContext *ua, JOB_DBR *jr); 308 309 int find_arg_keyword(UAContext *ua, const char **list); 310 int find_arg(UAContext *ua, const char *keyword); 311 int find_arg_with_value(UAContext *ua, const char *keyword); 312 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list); 313 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg); 314 int confirm_retention_yesno(UAContext *ua, utime_t ret, const char *msg); 315 bool get_level_from_name(JCR *jcr, const char *level_name); 316 int get_level_code_from_name(const char *level_name); 317 318 int scan_storage_cmd(UAContext *ua, const char *cmd, 319 bool allfrompool, 320 int *drive, MEDIA_DBR *mr, POOL_DBR *pr, 321 const char **action, char *storage, int *nb, uint32_t **results); 322 323 int scan_truncate_cmd(UAContext *ua, const char *cmd, 324 char *truncate_opt); 325 /* ua_status.c */ 326 void list_dir_status_header(UAContext *ua); 327 328 /* ua_tree.c */ 329 bool user_select_files_from_tree(TREE_CTX *tree); 330 int insert_tree_handler(void *ctx, int num_fields, char **row); 331 bool check_directory_acl(char **last_dir, alist *dir_acl, const char *path); 332 333 /* ua_prune.c */ 334 int prune_files(UAContext *ua, CLIENT *client, POOL *pool); 335 int prune_jobs(UAContext *ua, CLIENT *client, POOL *pool, int JobType); 336 int prune_stats(UAContext *ua, utime_t retention); 337 bool prune_volume(UAContext *ua, MEDIA_DBR *mr); 338 int job_delete_handler(void *ctx, int num_fields, char **row); 339 int del_count_handler(void *ctx, int num_fields, char **row); 340 int file_delete_handler(void *ctx, int num_fields, char **row); 341 int get_prune_list_for_volume(UAContext *ua, MEDIA_DBR *mr, del_ctx *del); 342 int exclude_running_jobs_from_list(del_ctx *prune_list); 343 344 /* ua_purge.c */ 345 bool is_volume_purged(UAContext *ua, MEDIA_DBR *mr, bool force=false); 346 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr); 347 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr); 348 bool purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr, bool force=false); 349 void purge_files_from_jobs(UAContext *ua, char *jobs); 350 void purge_jobs_from_catalog(UAContext *ua, char *jobs); 351 void purge_job_list_from_catalog(UAContext *ua, del_ctx &del); 352 void purge_files_from_job_list(UAContext *ua, del_ctx &del); 353 354 355 /* ua_run.c */ 356 extern int run_cmd(UAContext *ua, const char *cmd); 357 extern int restart_cmd(UAContext *ua, const char *cmd); 358 extern bool check_pool(int32_t JobType, int32_t JobLevel, POOL *pool, POOL *nextpool, const char **name); 359 360 /* verify.c */ 361 extern bool do_verify(JCR *jcr); 362 extern bool do_verify_init(JCR *jcr); 363 extern void verify_cleanup(JCR *jcr, int TermCode); 364 365 /* snapshot.c */ 366 int select_snapshot_dbr(UAContext *ua, SNAPSHOT_DBR *sr); 367 void snapshot_list(UAContext *ua, int i, DB_LIST_HANDLER *sendit, e_list_type llist); 368 int snapshot_cmd(UAContext *ua, const char *cmd); 369 int snapshot_catreq(JCR *jcr, BSOCK *bs); 370 int delete_snapshot(UAContext *ua); 371 bool update_snapshot(UAContext *ua); 372 int prune_snapshot(UAContext *ua); 373 bool send_snapshot_retention(JCR *jcr, utime_t val); 374 375 /* ua_collect.c */ 376 bool update_permanent_stats(void *data); 377 void initialize_statcollector(); 378 void start_collector_threads(); 379 void terminate_collector_threads(); 380 void update_config_stats(); 381 382 bool catreq_get_pool_info(JCR *jcr, BSOCK *bs); 383 384 #if BEEF 385 # include "bee_dird_uid.h" 386 #else 387 # define send_job_permissions(x) true 388 # define mark_access_denied(a) 389 #endif 390 391 /* dedup_util.c */ 392 bool is_dedup_ref(DEV_RECORD *rec, bool lazy); 393