git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/protos.h

   1 /*
   2  * Director external function prototypes
   3  *
   4  *   Version $Id$
   5  */
   6 /*
   7    Copyright (C) 2000-2005 Kern Sibbald
   8
   9    This program is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU General Public License
  11    version 2 as amended with additional clauses defined in the
  12    file LICENSE in the main source directory.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17    the file LICENSE for additional details.
  18
  19  */
  20
  21 /* admin.c */
  22 extern bool do_admin_init(JCR *jcr);
  23 extern bool do_admin(JCR *jcr);
  24 extern void admin_cleanup(JCR *jcr, int TermCode);
  25
  26
  27 /* authenticate.c */
  28 extern bool authenticate_storage_daemon(JCR *jcr, STORE *store);
  29 extern int authenticate_file_daemon(JCR *jcr);
  30 extern int authenticate_user_agent(UAContext *ua);
  31
  32 /* autoprune.c */
  33 extern int do_autoprune(JCR *jcr);
  34 extern int prune_volumes(JCR *jcr);
  35
  36 /* autorecycle.c */
  37 extern int recycle_oldest_purged_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  38 extern int recycle_volume(JCR *jcr, MEDIA_DBR *mr);
  39 extern int find_recycled_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  40
  41 /* backup.c */
  42 extern int wait_for_job_termination(JCR *jcr);
  43 extern bool do_backup_init(JCR *jcr);
  44 extern bool do_backup(JCR *jcr);
  45 extern void backup_cleanup(JCR *jcr, int TermCode);
  46
  47 /* bsr.c */
  48 RBSR *new_bsr();
  49 void free_bsr(RBSR *bsr);
  50 bool complete_bsr(UAContext *ua, RBSR *bsr);
  51 uint32_t write_bsr_file(UAContext *ua, RESTORE_CTX &rx);
  52 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex);
  53 void add_findex_all(RBSR *bsr, uint32_t JobId);
  54 RBSR_FINDEX *new_findex();
  55 void make_unique_restore_filename(UAContext *ua, POOLMEM **fname);
  56
  57
  58 /* catreq.c */
  59 extern void catalog_request(JCR *jcr, BSOCK *bs, char *buf);
  60 extern void catalog_update(JCR *jcr, BSOCK *bs, char *buf);
  61
  62 /* dird_conf.c */
  63 extern const char *level_to_str(int level);
  64
  65 /* expand.c */
  66 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp);
  67
  68
  69 /* fd_cmds.c */
  70 extern int connect_to_file_daemon(JCR *jcr, int retry_interval,
  71                                   int max_retry_time, int verbose);
  72 extern bool send_include_list(JCR *jcr);
  73 extern bool send_exclude_list(JCR *jcr);
  74 extern bool send_bootstrap_file(JCR *jcr);
  75 extern bool send_level_command(JCR *jcr);
  76 extern int get_attributes_and_put_in_catalog(JCR *jcr);
  77 extern int get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId);
  78 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname,
  79                           char *link, char *attr, int stream);
  80 extern void get_level_since_time(JCR *jcr, char *since, int since_len);
  81 extern int send_run_before_and_after_commands(JCR *jcr);
  82
  83 /* getmsg.c */
  84 enum e_prtmsg {
  85    DISPLAY_ERROR,
  86    NO_DISPLAY
  87 };
  88 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg);
  89
  90 /* job.c */
  91 extern void set_jcr_defaults(JCR *jcr, JOB *job);
  92 extern void create_unique_job_name(JCR *jcr, const char *base_name);
  93 extern void update_job_end_record(JCR *jcr);
  94 extern bool get_or_create_client_record(JCR *jcr);
  95 extern bool get_or_create_fileset_record(JCR *jcr);
  96 extern JobId_t run_job(JCR *jcr);
  97 extern bool cancel_job(UAContext *ua, JCR *jcr);
  98 extern void init_jcr_job_record(JCR *jcr);
  99 extern void copy_storage(JCR *new_jcr, JCR *old_jcr);
 100 extern void set_storage(JCR *jcr, STORE *store);
 101
 102 /* mac.c */
 103 extern bool do_mac(JCR *jcr);
 104 extern bool do_mac_init(JCR *jcr);
 105 extern void mac_cleanup(JCR *jcr, int TermCode);
 106
 107
 108 /* mountreq.c */
 109 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
 110
 111 /* msgchan.c */
 112 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
 113                               int max_retry_time, int verbose);
 114 extern int start_storage_daemon_job(JCR *jcr, alist *store, int append);
 115 extern int start_storage_daemon_message_thread(JCR *jcr);
 116 extern int bget_dirmsg(BSOCK *bs);
 117 extern void wait_for_storage_daemon_termination(JCR *jcr);
 118
 119 /* next_vol.c */
 120 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, bool create);
 121 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 122 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 123
 124 /* newvol.c */
 125 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 126
 127 /* python.c */
 128 int generate_job_event(JCR *jcr, const char *event);
 129
 130
 131 /* restore.c */
 132 extern bool do_restore(JCR *jcr);
 133 extern bool do_restore_init(JCR *jcr);
 134 extern void restore_cleanup(JCR *jcr, int TermCode);
 135
 136
 137 /* ua_acl.c */
 138 bool acl_access_ok(UAContext *ua, int acl, char *item);
 139 bool acl_access_ok(UAContext *ua, int acl, char *item, int len);
 140
 141 /* ua_cmds.c */
 142 int do_a_command(UAContext *ua, const char *cmd);
 143 int do_a_dot_command(UAContext *ua, const char *cmd);
 144 int qmessagescmd(UAContext *ua, const char *cmd);
 145 int open_db(UAContext *ua);
 146 void close_db(UAContext *ua);
 147 enum e_pool_op {
 148    POOL_OP_UPDATE,
 149    POOL_OP_CREATE
 150 };
 151 int create_pool(JCR *jcr, B_DB *db, POOL *pool, e_pool_op op);
 152 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr);
 153
 154 /* ua_input.c */
 155 int get_cmd(UAContext *ua, const char *prompt);
 156 bool get_pint(UAContext *ua, const char *prompt);
 157 bool get_yesno(UAContext *ua, const char *prompt);
 158 void parse_ua_args(UAContext *ua);
 159
 160 /* ua_label.c */
 161 bool is_volume_name_legal(UAContext *ua, const char *name);
 162
 163 /* ua_output.c */
 164 void prtit(void *ctx, const char *msg);
 165 int complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 166 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime);
 167
 168 /* ua_restore.c */
 169 int get_next_jobid_from_list(char **p, JobId_t *JobId);
 170
 171 /* ua_server.c */
 172 void bsendmsg(void *sock, const char *fmt, ...);
 173 UAContext *new_ua_context(JCR *jcr);
 174 JCR *new_control_jcr(const char *base_name, int job_type);
 175 void free_ua_context(UAContext *ua);
 176
 177 /* ua_select.c */
 178 STORE   *select_storage_resource(UAContext *ua);
 179 JOB     *select_job_resource(UAContext *ua);
 180 JOB     *select_restore_job_resource(UAContext *ua);
 181 CLIENT  *select_client_resource(UAContext *ua);
 182 FILESET *select_fileset_resource(UAContext *ua);
 183 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 184 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 185 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr);
 186 int     select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 187
 188 void    start_prompt(UAContext *ua, const char *msg);
 189 void    add_prompt(UAContext *ua, const char *prompt);
 190 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 191 CAT    *get_catalog_resource(UAContext *ua);
 192 STORE  *get_storage_resource(UAContext *ua, bool use_default);
 193 int     get_storage_drive(UAContext *ua, STORE *store);
 194 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 195 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr);
 196 int     get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 197 POOL   *get_pool_resource(UAContext *ua);
 198 POOL   *select_pool_resource(UAContext *ua);
 199 CLIENT *get_client_resource(UAContext *ua);
 200 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 201
 202 int find_arg_keyword(UAContext *ua, const char **list);
 203 int find_arg(UAContext *ua, const char *keyword);
 204 int find_arg_with_value(UAContext *ua, const char *keyword);
 205 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 206 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 207 bool get_level_from_name(JCR *jcr, const char *level_name);
 208
 209 /* ua_tree.c */
 210 bool user_select_files_from_tree(TREE_CTX *tree);
 211 int insert_tree_handler(void *ctx, int num_fields, char **row);
 212
 213 /* ua_prune.c */
 214 int prune_files(UAContext *ua, CLIENT *client);
 215 int prune_jobs(UAContext *ua, CLIENT *client, int JobType);
 216 int prune_volume(UAContext *ua, MEDIA_DBR *mr);
 217
 218 /* ua_purge.c */
 219 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr);
 220 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr );
 221 int purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr);
 222 void purge_files_from_job(UAContext *ua, JOB_DBR *jr);
 223
 224
 225 /* ua_run.c */
 226 extern int run_cmd(UAContext *ua, const char *cmd);
 227
 228 /* verify.c */
 229 extern bool do_verify(JCR *jcr);
 230 extern bool do_verify_init(JCR *jcr);
 231 extern void verify_cleanup(JCR *jcr, int TermCode);