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 79 80 /* catreq.c */ 81 extern void catalog_request(JCR *jcr, BSOCK *bs); 82 extern void catalog_update(JCR *jcr, BSOCK *bs); 83 extern bool despool_attributes_from_file(JCR *jcr, const char *file); 84 extern void remove_dummy_jobmedia_records(JCR *jcr); 85 86 /* dird_conf.c */ 87 extern const char *level_to_static_str(int level); 88 extern char *level_to_str(char *buf, int len, int level); 89 extern "C" char *job_code_callback_director(JCR *jcr, const char*, char *, int); 90 91 /* expand.c */ 92 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp); 93 94 95 /* fd_cmds.c */ 96 extern int connect_to_file_daemon(JCR *jcr, int retry_interval, 97 int max_retry_time, int verbose); 98 extern bool send_ls_fileset(JCR *jcr, const char *path); 99 extern bool send_ls_plugin_fileset(JCR *jcr, const char *plugin, const char *path); 100 extern bool send_include_list(JCR *jcr); 101 extern bool send_exclude_list(JCR *jcr); 102 extern bool send_level_command(JCR *jcr); 103 extern bool send_bwlimit(JCR *jcr, const char *Job); 104 extern int get_attributes_and_put_in_catalog(JCR *jcr); 105 extern void get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId); 106 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname, 107 char *link, char *attr, int stream); 108 extern void get_level_since_time(JCR *jcr, char *since, int since_len); 109 extern int send_runscripts_commands(JCR *jcr); 110 extern bool send_restore_objects(JCR *jcr); 111 extern bool send_component_info(JCR *jcr); 112 113 /* getmsg.c */ 114 enum e_prtmsg { 115 DISPLAY_ERROR, 116 NO_DISPLAY 117 }; 118 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg); 119 120 /* job.c */ 121 extern bool allow_duplicate_job(JCR *jcr); 122 extern void set_jcr_defaults(JCR *jcr, JOB *job); 123 extern void create_unique_job_name(JCR *jcr, const char *base_name); 124 extern void update_job_end_record(JCR *jcr); 125 extern bool get_or_create_client_record(JCR *jcr); 126 extern bool get_or_create_fileset_record(JCR *jcr); 127 extern DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name); 128 extern void apply_pool_overrides(JCR *jcr); 129 extern bool apply_wstorage_overrides(JCR *jcr, POOL *original_pool); 130 extern JobId_t run_job(JCR *jcr); 131 extern JobId_t resume_job(JCR *jcr, JOB_DBR *jr); 132 extern bool cancel_job(UAContext *ua, JCR *jcr, int wait, bool cancel=true); 133 extern int cancel_inactive_job(UAContext *ua); 134 extern void get_job_storage(USTORE *store, JOB *job, RUN *run); 135 extern void init_jcr_job_record(JCR *jcr); 136 extern void update_job_end(JCR *jcr, int TermCode); 137 extern void copy_rwstorage(JCR *jcr, alist *storage, const char *where); 138 extern void set_rwstorage(JCR *jcr, USTORE *store); 139 extern void free_rwstorage(JCR *jcr); 140 extern void copy_wstorage(JCR *jcr, alist *storage, const char *where); 141 extern void set_wstorage(JCR *jcr, USTORE *store); 142 extern void free_wstorage(JCR *jcr); 143 extern void copy_rstorage(JCR *jcr, alist *storage, const char *where); 144 extern void set_rstorage(JCR *jcr, USTORE *store); 145 extern void free_rstorage(JCR *jcr); 146 extern bool setup_job(JCR *jcr); 147 extern void create_clones(JCR *jcr); 148 extern int create_restore_bootstrap_file(JCR *jcr); 149 extern int create_restore_bootstrap_file(JCR *jcr, JobId_t jobid, int findex1, int findex2); 150 extern void dird_free_jcr(JCR *jcr); 151 extern void dird_free_jcr_pointers(JCR *jcr); 152 extern void cancel_storage_daemon_job(JCR *jcr); 153 extern bool run_console_command(JCR *jcr, const char *cmd); 154 extern void sd_msg_thread_send_signal(JCR *jcr, int sig); 155 void terminate_sd_msg_chan_thread(JCR *jcr); 156 bool flush_file_records(JCR *jcr); 157 158 /* jobq.c */ 159 extern bool inc_read_store(JCR *jcr); 160 extern void dec_read_store(JCR *jcr); 161 162 /* mac.c */ 163 extern bool do_mac(JCR *jcr); 164 extern bool do_mac_init(JCR *jcr); 165 extern void mac_cleanup(JCR *jcr, int TermCode, int writeTermCode); 166 extern bool set_mac_wstorage(UAContext *ua, JCR *jcr, POOL *pool, 167 POOL *next_pool, const char *source); 168 169 170 /* mountreq.c */ 171 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf); 172 173 /* msgchan.c */ 174 extern BSOCK *open_sd_bsock(UAContext *ua); 175 extern void close_sd_bsock(UAContext *ua); 176 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval, 177 int max_retry_time, int verbose); 178 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore, 179 bool send_bsr=false); 180 extern bool start_storage_daemon_message_thread(JCR *jcr); 181 extern int bget_dirmsg(BSOCK *bs); 182 extern void wait_for_storage_daemon_termination(JCR *jcr); 183 extern bool send_bootstrap_file(JCR *jcr, BSOCK *sd); 184 185 /* next_vol.c */ 186 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index, 187 bool create, bool purge, POOL_MEM &errmsg); 188 void set_storageid_in_mr(STORE *store, MEDIA_DBR *mr); 189 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr); 190 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason); 191 bool get_scratch_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr, 192 STORE *store); 193 194 /* newvol.c */ 195 bool newVolume(JCR *jcr, MEDIA_DBR *mr, STORE *store, POOL_MEM &errmsg); 196 197 /* restore.c */ 198 extern bool do_restore(JCR *jcr); 199 extern bool do_restore_init(JCR *jcr); 200 extern void restore_cleanup(JCR *jcr, int TermCode); 201 202 203 /* ua_acl.c */ 204 bool acl_access_ok(UAContext *ua, int acl, const char *item); 205 bool acl_access_ok(UAContext *ua, int acl, const char *item, int len); 206 bool have_restricted_acl(UAContext *ua, int acl); 207 bool acl_access_client_ok(UAContext *ua, const char *name, int32_t jobtype); 208 209 /* ua_cmds.c */ 210 bool get_uid_gid_from_acl(UAContext *ua, alist **uid, alist **gid, alist **dir); 211 bool do_a_command(UAContext *ua); 212 bool do_a_dot_command(UAContext *ua); 213 int qmessagescmd(UAContext *ua, const char *cmd); 214 bool open_new_client_db(UAContext *ua); 215 bool open_client_db(UAContext *ua); 216 bool open_db(UAContext *ua); 217 void close_db(UAContext *ua); 218 int cloud_volumes_cmd(UAContext *ua, const char *cmd, const char *mode); 219 enum e_pool_op { 220 POOL_OP_UPDATE, 221 POOL_OP_CREATE 222 }; 223 int create_pool(JCR *jcr, BDB *db, POOL *pool, e_pool_op op); 224 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr); 225 bool set_pooldbr_references(JCR *jcr, BDB *db, POOL_DBR *pr, POOL *pool); 226 void set_pooldbr_from_poolres(POOL_DBR *pr, POOL *pool, e_pool_op op); 227 int update_pool_references(JCR *jcr, BDB *db, POOL *pool); 228 229 /* ua_input.c */ 230 bool get_cmd(UAContext *ua, const char *prompt, bool subprompt=false); 231 bool get_selection_list(UAContext *ua, sellist &sl, const char *prompt, bool subprompt=false); 232 bool get_pint(UAContext *ua, const char *prompt); 233 bool get_yesno(UAContext *ua, const char *prompt); 234 bool is_yesno(char *val, int *ret); 235 int get_enabled(UAContext *ua, const char *val); 236 void parse_ua_args(UAContext *ua); 237 bool is_comment_legal(UAContext *ua, const char *name); 238 239 /* ua_label.c */ 240 bool is_volume_name_legal(UAContext *ua, const char *name); 241 int get_num_drives_from_SD(UAContext *ua); 242 void update_slots(UAContext *ua); 243 244 /* ua_update.c */ 245 void update_vol_pool(UAContext *ua, char *val, MEDIA_DBR *mr, POOL_DBR *opr); 246 247 /* ua_output.c */ 248 void prtit(void *ctx, const char *msg); 249 bool complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool); 250 RUN *find_next_run(RUN *run, JOB *job, utime_t &runtime, int ndays); 251 bool acl_access_jobid_ok(UAContext *ua, const char *jobids); 252 253 /* ua_restore.c */ 254 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType); 255 bool insert_table_into_findex_list(UAContext *ua, RESTORE_CTX *rx, char *table); 256 void new_rx(RESTORE_CTX *rx); 257 void free_rx(RESTORE_CTX *rx); 258 259 /* ua_server.c */ 260 void bsendmsg(void *ua_ctx, const char *fmt, ...); 261 void berrormsg(void *ua_ctx, const char *fmt, ...); 262 void bwarningmsg(void *ua_ctx, const char *fmt, ...); 263 void binfomsg(void *ua_ctx, const char *fmt, ...); 264 UAContext *new_ua_context(JCR *jcr); 265 JCR *new_control_jcr(const char *base_name, int job_type); 266 void free_ua_context(UAContext *ua); 267 268 /* ua_select.c */ 269 STORE *select_storage_resource(UAContext *ua, bool unique=false); 270 JOB *select_job_resource(UAContext *ua); 271 JOB *select_enable_disable_job_resource(UAContext *ua, bool enable); 272 JOB *select_restore_job_resource(UAContext *ua); 273 CLIENT *select_enable_disable_client_resource(UAContext *ua, bool enable); 274 CLIENT *select_client_resource(UAContext *ua, int32_t jobtype); 275 FILESET *select_fileset_resource(UAContext *ua); 276 SCHED *select_enable_disable_schedule_resource(UAContext *ua, bool enable); 277 int select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr); 278 int select_media_dbr(UAContext *ua, MEDIA_DBR *mr); 279 bool select_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool"); 280 bool select_client_dbr(UAContext *ua, CLIENT_DBR *cr, int32_t jobtype); 281 282 void start_prompt(UAContext *ua, const char *msg); 283 void add_prompt(UAContext *ua, const char *prompt, char *unique=NULL); 284 int do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt); 285 int do_alist_prompt(UAContext *ua, const char *automsg, const char *msg, 286 alist *selected); 287 CAT *get_catalog_resource(UAContext *ua); 288 STORE *get_storage_resource(UAContext *ua, bool use_default, bool unique=false); 289 int get_storage_drive(UAContext *ua, STORE *store); 290 int get_storage_slot(UAContext *ua, STORE *store); 291 int get_media_type(UAContext *ua, char *MediaType, int max_media); 292 bool get_pool_dbr(UAContext *ua, POOL_DBR *pr, const char *argk="pool"); 293 bool get_client_dbr(UAContext *ua, CLIENT_DBR *cr, int32_t jobtype); 294 POOL *get_pool_resource(UAContext *ua); 295 JOB *get_restore_job(UAContext *ua); 296 POOL *select_pool_resource(UAContext *ua); 297 int select_running_jobs(UAContext *ua, alist *jcrs, const char *reason); 298 CLIENT *get_client_resource(UAContext *ua, int32_t jobtype); 299 int get_job_dbr(UAContext *ua, JOB_DBR *jr); 300 301 int find_arg_keyword(UAContext *ua, const char **list); 302 int find_arg(UAContext *ua, const char *keyword); 303 int find_arg_with_value(UAContext *ua, const char *keyword); 304 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list); 305 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg); 306 int confirm_retention_yesno(UAContext *ua, utime_t ret, const char *msg); 307 bool get_level_from_name(JCR *jcr, const char *level_name); 308 int get_level_code_from_name(const char *level_name); 309 int scan_storage_cmd(UAContext *ua, const char *cmd, 310 bool allfrompool, 311 int *drive, MEDIA_DBR *mr, POOL_DBR *pr, 312 const char **action, char *storage, int *nb, uint32_t **results); 313 314 315 /* ua_status.c */ 316 void list_dir_status_header(UAContext *ua); 317 318 /* ua_tree.c */ 319 bool user_select_files_from_tree(TREE_CTX *tree); 320 int insert_tree_handler(void *ctx, int num_fields, char **row); 321 bool check_directory_acl(char **last_dir, alist *dir_acl, const char *path); 322 323 /* ua_prune.c */ 324 int prune_files(UAContext *ua, CLIENT *client, POOL *pool); 325 int prune_jobs(UAContext *ua, CLIENT *client, POOL *pool, int JobType); 326 int prune_stats(UAContext *ua, utime_t retention); 327 bool prune_volume(UAContext *ua, MEDIA_DBR *mr); 328 int job_delete_handler(void *ctx, int num_fields, char **row); 329 int del_count_handler(void *ctx, int num_fields, char **row); 330 int file_delete_handler(void *ctx, int num_fields, char **row); 331 int get_prune_list_for_volume(UAContext *ua, MEDIA_DBR *mr, del_ctx *del); 332 int exclude_running_jobs_from_list(del_ctx *prune_list); 333 334 /* ua_purge.c */ 335 bool is_volume_purged(UAContext *ua, MEDIA_DBR *mr, bool force=false); 336 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr); 337 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr); 338 bool purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr, bool force=false); 339 void purge_files_from_jobs(UAContext *ua, char *jobs); 340 void purge_jobs_from_catalog(UAContext *ua, char *jobs); 341 void purge_job_list_from_catalog(UAContext *ua, del_ctx &del); 342 void purge_files_from_job_list(UAContext *ua, del_ctx &del); 343 344 345 /* ua_run.c */ 346 extern int run_cmd(UAContext *ua, const char *cmd); 347 extern int restart_cmd(UAContext *ua, const char *cmd); 348 extern bool check_pool(int32_t JobType, int32_t JobLevel, POOL *pool, POOL *nextpool, const char **name); 349 350 /* verify.c */ 351 extern bool do_verify(JCR *jcr); 352 extern bool do_verify_init(JCR *jcr); 353 extern void verify_cleanup(JCR *jcr, int TermCode); 354 355 /* snapshot.c */ 356 int select_snapshot_dbr(UAContext *ua, SNAPSHOT_DBR *sr); 357 void snapshot_list(UAContext *ua, int i, DB_LIST_HANDLER *sendit, e_list_type llist); 358 int snapshot_cmd(UAContext *ua, const char *cmd); 359 int snapshot_catreq(JCR *jcr, BSOCK *bs); 360 int delete_snapshot(UAContext *ua); 361 bool update_snapshot(UAContext *ua); 362 int prune_snapshot(UAContext *ua); 363 bool send_snapshot_retention(JCR *jcr, utime_t val); 364 365 /* ua_collect.c */ 366 bool update_permanent_stats(void *data); 367 void initialize_statcollector(); 368 void start_collector_threads(); 369 void terminate_collector_threads(); 370 void update_config_stats(); 371