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    Bacula® - The Network Backup Solution
   8
   9    Copyright (C) 2000-2006 Free Software Foundation Europe e.V.
  10
  11    The main author of Bacula is Kern Sibbald, with contributions from
  12    many others, a complete list can be found in the file AUTHORS.
  13    This program is Free Software; you can redistribute it and/or
  14    modify it under the terms of version two of the GNU General Public
  15    License as published by the Free Software Foundation plus additions
  16    that are listed in the file LICENSE.
  17
  18    This program is distributed in the hope that it will be useful, but
  19    WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program; if not, write to the Free Software
  25    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26    02110-1301, USA.
  27
  28    Bacula® is a registered trademark of John Walker.
  29    The licensor of Bacula is the Free Software Foundation Europe
  30    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  31    Switzerland, email:ftf@fsfeurope.org.
  32 */
  33
  34 /* admin.c */
  35 extern bool do_admin_init(JCR *jcr);
  36 extern bool do_admin(JCR *jcr);
  37 extern void admin_cleanup(JCR *jcr, int TermCode);
  38
  39
  40 /* authenticate.c */
  41 extern bool authenticate_storage_daemon(JCR *jcr, STORE *store);
  42 extern int authenticate_file_daemon(JCR *jcr);
  43 extern int authenticate_user_agent(UAContext *ua);
  44
  45 /* autoprune.c */
  46 extern void do_autoprune(JCR *jcr);
  47 extern int prune_volumes(JCR *jcr);
  48
  49 /* autorecycle.c */
  50 extern bool recycle_oldest_purged_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  51 extern int recycle_volume(JCR *jcr, MEDIA_DBR *mr);
  52 extern bool find_recycled_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr);
  53
  54 /* backup.c */
  55 extern int wait_for_job_termination(JCR *jcr);
  56 extern bool do_backup_init(JCR *jcr);
  57 extern bool do_backup(JCR *jcr);
  58 extern void backup_cleanup(JCR *jcr, int TermCode);
  59 extern void update_bootstrap_file(JCR *jcr);
  60
  61 /* bsr.c */
  62 RBSR *new_bsr();
  63 void free_bsr(RBSR *bsr);
  64 bool complete_bsr(UAContext *ua, RBSR *bsr);
  65 uint32_t write_bsr_file(UAContext *ua, RESTORE_CTX &rx);
  66 void add_findex(RBSR *bsr, uint32_t JobId, int32_t findex);
  67 void add_findex_all(RBSR *bsr, uint32_t JobId);
  68 RBSR_FINDEX *new_findex();
  69 void make_unique_restore_filename(UAContext *ua, POOLMEM **fname);
  70
  71
  72 /* catreq.c */
  73 extern void catalog_request(JCR *jcr, BSOCK *bs);
  74 extern void catalog_update(JCR *jcr, BSOCK *bs);
  75
  76 /* dird_conf.c */
  77 extern const char *level_to_str(int level);
  78
  79 /* expand.c */
  80 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp);
  81
  82
  83 /* fd_cmds.c */
  84 extern int connect_to_file_daemon(JCR *jcr, int retry_interval,
  85                                   int max_retry_time, int verbose);
  86 extern bool send_include_list(JCR *jcr);
  87 extern bool send_exclude_list(JCR *jcr);
  88 extern bool send_bootstrap_file(JCR *jcr, BSOCK *sock);
  89 extern bool send_level_command(JCR *jcr);
  90 extern int get_attributes_and_put_in_catalog(JCR *jcr);
  91 extern int get_attributes_and_compare_to_catalog(JCR *jcr, JobId_t JobId);
  92 extern int put_file_into_catalog(JCR *jcr, long file_index, char *fname,
  93                           char *link, char *attr, int stream);
  94 extern void get_level_since_time(JCR *jcr, char *since, int since_len);
  95 extern int send_runscripts_commands(JCR *jcr);
  96
  97 /* getmsg.c */
  98 enum e_prtmsg {
  99    DISPLAY_ERROR,
 100    NO_DISPLAY
 101 };
 102 extern bool response(JCR *jcr, BSOCK *fd, char *resp, const char *cmd, e_prtmsg prtmsg);
 103
 104 /* job.c */
 105 extern void set_jcr_defaults(JCR *jcr, JOB *job);
 106 extern void create_unique_job_name(JCR *jcr, const char *base_name);
 107 extern void update_job_end_record(JCR *jcr);
 108 extern bool get_or_create_client_record(JCR *jcr);
 109 extern bool get_or_create_fileset_record(JCR *jcr);
 110 extern DBId_t get_or_create_pool_record(JCR *jcr, char *pool_name);
 111 extern void apply_pool_overrides(JCR *jcr);
 112 extern JobId_t run_job(JCR *jcr);
 113 extern bool cancel_job(UAContext *ua, JCR *jcr);
 114 extern void get_job_storage(USTORE *store, JOB *job, RUN *run);
 115 extern void init_jcr_job_record(JCR *jcr);
 116 extern void copy_rwstorage(JCR *jcr, alist *storage, const char *where);
 117 extern void set_rwstorage(JCR *jcr, USTORE *store);
 118 extern void free_rwstorage(JCR *jcr);
 119 extern void copy_wstorage(JCR *jcr, alist *storage, const char *where);
 120 extern void set_wstorage(JCR *jcr, USTORE *store);
 121 extern void free_wstorage(JCR *jcr);
 122 extern void copy_rstorage(JCR *jcr, alist *storage, const char *where);
 123 extern void set_rstorage(JCR *jcr, USTORE *store);
 124 extern void free_rstorage(JCR *jcr);
 125 extern bool setup_job(JCR *jcr);
 126 extern void create_clones(JCR *jcr);
 127 extern bool create_restore_bootstrap_file(JCR *jcr);
 128
 129 /* migration.c */
 130 extern bool do_migration(JCR *jcr);
 131 extern bool do_migration_init(JCR *jcr);
 132 extern void migration_cleanup(JCR *jcr, int TermCode);
 133 extern bool set_migration_wstorage(JCR *jcr, POOL *pool);
 134
 135
 136 /* mountreq.c */
 137 extern void mount_request(JCR *jcr, BSOCK *bs, char *buf);
 138
 139 /* msgchan.c */
 140 extern bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
 141                               int max_retry_time, int verbose);
 142 extern bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore);
 143 extern int start_storage_daemon_message_thread(JCR *jcr);
 144 extern int bget_dirmsg(BSOCK *bs);
 145 extern void wait_for_storage_daemon_termination(JCR *jcr);
 146
 147 /* next_vol.c */
 148 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index, bool create);
 149 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr);
 150 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason);
 151
 152 /* newvol.c */
 153 bool newVolume(JCR *jcr, MEDIA_DBR *mr);
 154
 155 /* python.c */
 156 int generate_job_event(JCR *jcr, const char *event);
 157
 158
 159 /* restore.c */
 160 extern bool do_restore(JCR *jcr);
 161 extern bool do_restore_init(JCR *jcr);
 162 extern void restore_cleanup(JCR *jcr, int TermCode);
 163
 164
 165 /* ua_acl.c */
 166 bool acl_access_ok(UAContext *ua, int acl, char *item);
 167 bool acl_access_ok(UAContext *ua, int acl, char *item, int len);
 168
 169 /* ua_cmds.c */
 170 int do_a_command(UAContext *ua, const char *cmd);
 171 int do_a_dot_command(UAContext *ua, const char *cmd);
 172 int qmessagescmd(UAContext *ua, const char *cmd);
 173 bool open_db(UAContext *ua);
 174 void close_db(UAContext *ua);
 175 enum e_pool_op {
 176    POOL_OP_UPDATE,
 177    POOL_OP_CREATE
 178 };
 179 int create_pool(JCR *jcr, B_DB *db, POOL *pool, e_pool_op op);
 180 void set_pool_dbr_defaults_in_media_dbr(MEDIA_DBR *mr, POOL_DBR *pr);
 181 void set_pooldbr_from_poolres(POOL_DBR *pr, POOL *pool, e_pool_op op);
 182
 183 /* ua_input.c */
 184 int get_cmd(UAContext *ua, const char *prompt);
 185 bool get_pint(UAContext *ua, const char *prompt);
 186 bool get_yesno(UAContext *ua, const char *prompt);
 187 bool is_yesno(char *val, int *ret);
 188 int get_enabled(UAContext *ua, const char *val);
 189 void parse_ua_args(UAContext *ua);
 190
 191 /* ua_label.c */
 192 bool is_volume_name_legal(UAContext *ua, const char *name);
 193 int get_num_drives_from_SD(UAContext *ua);
 194 void update_slots(UAContext *ua);
 195
 196 /* ua_output.c */
 197 void prtit(void *ctx, const char *msg);
 198 int complete_jcr_for_job(JCR *jcr, JOB *job, POOL *pool);
 199 RUN *find_next_run(RUN *run, JOB *job, time_t &runtime, int ndays);
 200
 201 /* ua_restore.c */
 202 int get_next_jobid_from_list(char **p, JobId_t *JobId);
 203 void find_storage_resource(UAContext *ua, RESTORE_CTX &rx, char *Storage, char *MediaType);
 204
 205 /* ua_server.c */
 206 void bsendmsg(void *sock, const char *fmt, ...);
 207 UAContext *new_ua_context(JCR *jcr);
 208 JCR *new_control_jcr(const char *base_name, int job_type);
 209 void free_ua_context(UAContext *ua);
 210
 211 /* ua_select.c */
 212 STORE   *select_storage_resource(UAContext *ua);
 213 JOB     *select_job_resource(UAContext *ua);
 214 JOB     *select_restore_job_resource(UAContext *ua);
 215 CLIENT  *select_client_resource(UAContext *ua);
 216 FILESET *select_fileset_resource(UAContext *ua);
 217 int     select_pool_and_media_dbr(UAContext *ua, POOL_DBR *pr, MEDIA_DBR *mr);
 218 int     select_media_dbr(UAContext *ua, MEDIA_DBR *mr);
 219 bool    select_pool_dbr(UAContext *ua, POOL_DBR *pr);
 220 int     select_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 221
 222 void    start_prompt(UAContext *ua, const char *msg);
 223 void    add_prompt(UAContext *ua, const char *prompt);
 224 int     do_prompt(UAContext *ua, const char *automsg, const char *msg, char *prompt, int max_prompt);
 225 CAT    *get_catalog_resource(UAContext *ua);
 226 STORE  *get_storage_resource(UAContext *ua, bool use_default);
 227 int     get_storage_drive(UAContext *ua, STORE *store);
 228 int     get_storage_slot(UAContext *ua, STORE *store);
 229 int     get_media_type(UAContext *ua, char *MediaType, int max_media);
 230 bool    get_pool_dbr(UAContext *ua, POOL_DBR *pr);
 231 int     get_client_dbr(UAContext *ua, CLIENT_DBR *cr);
 232 POOL   *get_pool_resource(UAContext *ua);
 233 POOL   *select_pool_resource(UAContext *ua);
 234 CLIENT *get_client_resource(UAContext *ua);
 235 int     get_job_dbr(UAContext *ua, JOB_DBR *jr);
 236
 237 int find_arg_keyword(UAContext *ua, const char **list);
 238 int find_arg(UAContext *ua, const char *keyword);
 239 int find_arg_with_value(UAContext *ua, const char *keyword);
 240 int do_keyword_prompt(UAContext *ua, const char *msg, const char **list);
 241 int confirm_retention(UAContext *ua, utime_t *ret, const char *msg);
 242 bool get_level_from_name(JCR *jcr, const char *level_name);
 243
 244 /* ua_tree.c */
 245 bool user_select_files_from_tree(TREE_CTX *tree);
 246 int insert_tree_handler(void *ctx, int num_fields, char **row);
 247
 248 /* ua_prune.c */
 249 int prune_files(UAContext *ua, CLIENT *client);
 250 int prune_jobs(UAContext *ua, CLIENT *client, int JobType);
 251 bool prune_volume(UAContext *ua, MEDIA_DBR *mr);
 252
 253 /* ua_purge.c */
 254 bool mark_media_purged(UAContext *ua, MEDIA_DBR *mr);
 255 void purge_files_from_volume(UAContext *ua, MEDIA_DBR *mr );
 256 int purge_jobs_from_volume(UAContext *ua, MEDIA_DBR *mr);
 257 void purge_files_from_job(UAContext *ua, JobId_t JobId);
 258 void purge_job_from_catalog(UAContext *ua, JobId_t JobId);
 259 void purge_job_records_from_catalog(UAContext *ua, JobId_t JobId);
 260
 261
 262 /* ua_run.c */
 263 extern int run_cmd(UAContext *ua, const char *cmd);
 264
 265 /* verify.c */
 266 extern bool do_verify(JCR *jcr);
 267 extern bool do_verify_init(JCR *jcr);
 268 extern void verify_cleanup(JCR *jcr, int TermCode);