/usr/include/dar/user_interaction.hpp is in libdar-dev 2.4.15-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 | /*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2052 Denis Corbin
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// to contact the author : http://dar.linux.free.fr/email.html
/*********************************************************************/
/// \file user_interaction.hpp
/// \brief defines the interaction between libdar and the user.
/// \ingroup API
///
/// Three classes are defined
/// - user_interaction is the root class that you can use to make your own classes
/// - user_interaction_callback is a specialized inherited class which is implements
/// user interaction thanks to callback functions
/// - user_interaction_blind provides fully usable objects that do not show anything
/// and always assume a negative answer from the user
/// .
///////////////////////////////////////////////////////////////////////
// IMPORTANT : THIS FILE MUST ALWAYS BE INCLUDE AFTER infinint.hpp //
// (and infinint.hpp must be included too, always) //
///////////////////////////////////////////////////////////////////////
#include "/usr/include/dar/infinint.hpp"
///////////////////////////////////////////////////////////////////////
#ifndef USER_INTERACTION_HPP
#define USER_INTERACTION_HPP
#include "/usr/include/dar/libdar_my_config.h"
#include <string>
#include "/usr/include/dar/erreurs.hpp"
#include "/usr/include/dar/integers.hpp"
#include "/usr/include/dar/secu_string.hpp"
namespace libdar
{
/// \addtogroup API
/// @{
/// This is a pure virtual class that is used by libdar when interaction with the user is required.
//! You can base your own class on it using C++ inheritance
//! or use the class user_interaction_callback which implements
//! the interaction based on callback functions.
//! The user_interaction class is used by libdar in the following circumpstances:
//! - when is required a boolean answer to a question the pause() method is used
//! - when a warning needs to be displayed to the user the warning() method is used
//! - when a directory listing needs to be returned to the user the listing() method is used
//! .
//! the printf() method is built over the warning() methods to display a formated message
//! it has not to be redefined in any inherited class.
//! If you want to define you own class as inherited class of user_interaction
//! you need to overwrite:
//! - the clone() method. It is used to make local temporary copies of objets
//! in libdar. It acts like the constructor copy but is virtual.
//! - the pause() method
//! - the warning() method
//! - the listing() method (this is not mandatory). inherited classes *can*
//! overwrite the listing() method, which will be used if the use_listing
//! is set to true thanks to the set_use_listing() protected method.
//! In that case the listing of archive contents is done thanks to this listing()
//! method instead of the warning() method.
//! - get_string() method
//! - get_secu_string() method
//! .
//! WARNING !
//! if your own class has specific fields, you will probably
//! need to redefine the copy constructor as well as operator =
//! if you don't understand this and why, don't play trying making your
//! own class, and/or read good C++ book about canonical form
//! of a C++ class, as well as how to properly make an inherited class.
//! And don't, complain if libdar segfault or core dumps. Libdar
//! *needs* to make local copies of these objects, if the copy constructor
//! is not properly defined in your inherited class this will crash the application.
//! \ingroup API
class user_interaction
{
public:
/// class constructor.
user_interaction();
virtual ~user_interaction() {};
/// method used to ask a boolean question to the user.
//! \param[in] message is the message to be displayed, that is the question.
//! \exception Euser_abort If the user answer "false" or "no" to the question the method
//! must throw an exception of type "Euser_abort".
virtual void pause(const std::string & message)
{
if(!pause2(message))
throw Euser_abort(message);
};
/// alternative method to the pause() method
//! \param[in] message The boolean question to ask to the user
//! \return the answer of the user (true/yes or no/false)
//! \note either pause2() or pause() *must* be overwritten, but not both.
//! libdar always calls pause() which default implementation relies on pause2() where it converts negative
//! return from pause2() by throwing the appropriated exception. As soon as you overwrite pause(),
//! pause2() is no more used.
virtual bool pause2(const std::string & message)
{ throw Elibcall("user_interaction::pause2", "user_interaction::pause() or pause2() must be overwritten !"); };
/// \brief method used to display a warning or a message to the user.
///
/// \param[in] message is the message to display.
/// \note since API 3.1.x this method must no more be ovewritten, instead
/// the protected method inherited_warning() must be used.
void warning(const std::string & message);
/// method used to ask a question that needs an arbitrary answer.
//! \param[in] message is the question to display to the user.
//! \param[in] echo is set to false is the answer must not be shown while the user answers.
//! \return the user's answer.
virtual std::string get_string(const std::string & message, bool echo) = 0;
/// same a get_string() but uses secu_string instead
//! \param[in] message is the question to display to the user.
//! \param[in] echo is set to false is the answer must not be shown while the user answers.
//! \return the user's answer.
virtual secu_string get_secu_string(const std::string & message, bool echo) = 0;
/// optional method to use if you want file listing splitted in several fields.
/// If you need to use this feature, you have then to supply an implementation for this method,
/// in your inherited class which will be called by libdar in place of the warning method
/// You then also have to call the set_use_listing() method with true as parameter
/// from the constructor of your inherited class (for example) to tell libdar that the listing() method is
/// to be used in place of the warning() method for archive listing.
//! \param[in] flag is the given information about the EA, compression, presence of saved data.
//! \param[in] perm is the access permission of the file.
//! \param[in] uid User ID of the file.
//! \param[in] gid Group ID of the file.
//! \param[in] size file size.
//! \param[in] date file modification date.
//! \param[in] filename file name.
//! \param[in] is_dir true if file is a directory.
//! \param[in] has_children true if file is a directory which is not empty.
//! \note This is not a pure virtual method, this is normal,
//! so your inherited class is not obliged to overwrite it.
virtual void listing(const std::string & flag,
const std::string & perm,
const std::string & uid,
const std::string & gid,
const std::string & size,
const std::string & date,
const std::string & filename,
bool is_dir,
bool has_children);
/// optional method to use if you want dar_manager database contents listing split in several fields.
/// if you want to use this feature, you have then to supply an implementation for this method
/// in your inherited class, method that will be called by libdar in place of the warning method.
/// You will also have to call the set_use_dar_manager_show_files() protected method with true as argument
/// from the constructor of your inherited class to tell libdar to use the dar_manager_show_files()
/// method in place of the warning() method.
/// \param[in] filename name of the file
/// \param[in] data_change whether the backup owns the most recent data for the file
/// \param[in] ea_change whether the backup owns the most recent Extended Attributes for the file
/// \note this method can be set for database::show_files() method to call it
virtual void dar_manager_show_files(const std::string & filename,
bool data_change,
bool ea_change);
/// optional method to use if you want dar_manager database archive listing split in several fields
/// if you want to use this feature, you have then to supply an implementation for this method
/// in your inherited class, method that will be called by libdar in place of the warning method.
/// You will also have to call the set_use_dar_manager_contents() protected method with true as argument
/// from the constructor of your inherited class to tell libdar to use the dar_manager_contents()
/// method in place of the warning() method.
/// \param[in] number is the number of the archive in the database
/// \param[in] chemin recorded path where to find this archive
/// \param[in] archive_name basename of this archive
/// \note this method can be set for database::show_contents() to call it
virtual void dar_manager_contents(U_I number,
const std::string & chemin,
const std::string & archive_name);
/// optional method to use if you want dar_manager statistics listing split in several fields
/// if you want to use this feature, you have then to supply an implementation for this method
/// in your inherited class, method that will be called by libdar in place of the warning method.
/// You will also have to call the set_use_dar_manager_statistics() protected method with true as argument
/// from the constructor of your inherited class to tell libdar to use the dar_manager_statistics()
/// method in place of the warning() method.
/// \param[in] number archive number
/// \param[in] data_count amount of file which last version is located in this archive
/// \param[in] total_data total number of file covered in this database
/// \param[in] ea_count amount of EA which last version is located in this archive
/// \param[in] total_ea total number of file that have EA covered by this database
/// \note this method can be set for database::show_most_recent_stats() method to call it
virtual void dar_manager_statistics(U_I number,
const infinint & data_count,
const infinint & total_data,
const infinint & ea_count,
const infinint & total_ea);
/// optional method to use if you want dar_manager statistics listing split in several fields
/// if you want to use this feature, you have then to supply an implementation for this method
/// in your inherited class, method that will be called by libdar in place of the warning method.
/// You will also have to call the set_use_dar_manager_show_version() protected method with true as argument
/// from the constructor of your inherited class to tell libdar to use the dar_manager_show_version()
/// method in place of the warning() method.
/// \param[in] number archive number
/// \param[in] data_date is the last modification date of the requested file in thie archive whose number is "number"
/// \param[in] data_presence is the nature of this modification, true if the data was saved, false if it was deleted
/// \param[in] ea_date is the date of the EA for the requested file in the archive whose number is "number"
/// \param[in] ea_presence is the nature of this modification, true if the EAs were saved, false if they were deleted
/// \note this method can be set for database::show_version() method to call it
virtual void dar_manager_show_version(U_I number,
const std::string & data_date,
const std::string & data_presence,
const std::string & ea_date,
const std::string & ea_presence);
/// libdar uses this call to format output before send to warning() method.
//! This is not a virtual method, it has not to be overwritten, it is
//! just a sublayer over warning()
//! Supported masks for the format string are:
//! - \%s \%c \%d \%\% (normal behavior)
//! - \%i (matches infinint *)
//! - \%S (matches std::string *)
//! .
void printf(const char *format, ...);
/// for libdar to know if it is interesting to use listing(), dar_manager_show_files(),
/// dar_manager_contents(), dar_manager_statistics() or to keep reporting listing thanks
/// to the warning() method,
//! this is not a virtual method, it has not to be overwritten in inherited classes.
bool get_use_listing() const { return use_listing; };
//! this is not a virtual method, it has not to be overwritten in inherited classes.
bool get_use_dar_manager_show_files() const { return use_dar_manager_show_files; };
//! this is not a virtual method, it has not to be overwritten in inherited classes.
bool get_use_dar_manager_contents() const { return use_dar_manager_contents; };
//! this is not a virtual method, it has not to be overwritten in inherited classes.
bool get_use_dar_manager_statistics() const { return use_dar_manager_statistics; };
//! this is not a virtual method, it has not to be overwritten in inherited classes.
bool get_use_dar_manager_show_version() const { return use_dar_manager_show_version; };
/// make a newly allocated object which has the same properties as "this".
//! This *is* a virtual method, it *must* be overwritten in any inherited class
//! copy constructor and = operator may have to be overwrittent too if necessary
//! Warning !
//! clone() must throw exception if necessary (Ememory), but never
//! return a NULL pointer !
virtual user_interaction *clone() const = 0;
/// make a pause each N line of output when calling the warning method
//! \param[in] num is the number of line to display at once, zero for unlimited display
//! \note. Since API 3.1, the warning method is no more a pure virtual function
//! you need to call the parent warning method in your method for this warning_with_more
//! method works as expected.
void warning_with_more(U_I num) { at_once = num; count = 0; };
protected:
/// method to be called with true as argument if you have defined a listing() method.
//! in the constructor of any inherited class that define a listing() method
//! it is advisable to call set_use_listing() with true as argument for libdar
//! knows that the listing() call has to be used in place of the warning() call
//! for file listing.
void set_use_listing(bool val) { use_listing = val; };
/// method to be called with true as argument if you have defined a dar_manager_show_files() method.
void set_use_dar_manager_show_files(bool val) { use_dar_manager_show_files = val; };
/// method to be called with true as argument if you have defined a dar_manager_contents() method.
void set_use_dar_manager_contents(bool val) { use_dar_manager_contents = val; };
/// method to be called with true as argument if you have defined a dar_manager_statistics() method.
void set_use_dar_manager_statistics(bool val) { use_dar_manager_statistics = val; };
/// method to be called with true as argument if you have defined a dar_manager_show_version() method.
void set_use_dar_manager_show_version(bool val) { use_dar_manager_show_version = val; };
/// need to be overwritten in place of the warning() method since API 3.1.x
/// \param[in] message message to display
///
virtual void inherited_warning(const std::string & message) = 0;
private:
bool use_listing;
bool use_dar_manager_show_files;
bool use_dar_manager_contents;
bool use_dar_manager_statistics;
bool use_dar_manager_show_version;
U_I at_once, count;
};
/// full implemented class for user_interaction based on callback functions.
//! this class is an inherited class of user_interaction it is used by
//! dar command line programs, but you can use it if you wish.
//! \ingroup API
class user_interaction_callback : public user_interaction
{
public:
/// constructor which receive the callback functions.
//! \param[in] x_warning_callback is used by warning() method
//! \param[in] x_answer_callback is used by the pause() method
//! \param[in] x_string_callback is used by get_string() method
//! \param[in] x_secu_string_callback is used by get_secu_string() method
//! \param[in] context_value will be passed as last argument of callbacks when
//! called from this object.
//! \note The context argument of each callback is set with the context_value given
//! in the user_interaction_callback object constructor. The value can
//! can be any arbitrary value (NULL is valid), and can be used as you wish.
//! Note that the listing callback is not defined here, but thanks to a specific method
user_interaction_callback(void (*x_warning_callback)(const std::string &x, void *context),
bool (*x_answer_callback)(const std::string &x, void *context),
std::string (*x_string_callback)(const std::string &x, bool echo, void *context),
secu_string (*x_secu_string_callback)(const std::string &x, bool echo, void *context),
void *context_value);
/// overwritting method from parent class.
void pause(const std::string & message);
/// overwritting method from parent class.
std::string get_string(const std::string & message, bool echo);
/// overwritting method from parent class.
secu_string get_secu_string(const std::string & message, bool echo);
/// overwritting method from parent class.
void listing(const std::string & flag,
const std::string & perm,
const std::string & uid,
const std::string & gid,
const std::string & size,
const std::string & date,
const std::string & filename,
bool is_dir,
bool has_children);
/// overwritting method from parent class
void dar_manager_show_files(const std::string & filename,
bool available_data,
bool available_ea);
/// overwritting method from parent class
void dar_manager_contents(U_I number,
const std::string & chemin,
const std::string & archive_name);
/// overwritting method from parent class
void dar_manager_statistics(U_I number,
const infinint & data_count,
const infinint & total_data,
const infinint & ea_count,
const infinint & total_ea);
/// overwritting method from parent class
void dar_manager_show_version(U_I number,
const std::string & data_date,
const std::string & data_presence,
const std::string & ea_date,
const std::string & ea_presence);
/// You can set a listing callback thanks to this method.
//! If set, when file listing will this callback function will
//! be used instead of the x_warning_callback given as argument
//! of the constructor.
void set_listing_callback(void (*callback)(const std::string & flag,
const std::string & perm,
const std::string & uid,
const std::string & gid,
const std::string & size,
const std::string & date,
const std::string & filename,
bool is_dir,
bool has_children,
void *context))
{
tar_listing_callback = callback;
set_use_listing(true); // this is to inform libdar to use listing()
};
// You can set a dar_manager_show_files callback thanks to this method
void set_dar_manager_show_files_callback(void (*callback)(const std::string & filename,
bool available_data,
bool available_ea,
void *context))
{
dar_manager_show_files_callback = callback;
set_use_dar_manager_show_files(true); // this is to inform libdar to use the dar_manager_show_files() method
};
void set_dar_manager_contents_callback(void (*callback)(U_I number,
const std::string & chemin,
const std::string & archive_name,
void *context))
{
dar_manager_contents_callback = callback;
set_use_dar_manager_contents(true); // this is to inform libdar to use the dar_manager_contents() method
};
void set_dar_manager_statistics_callback(void (*callback)(U_I number,
const infinint & data_count,
const infinint & total_data,
const infinint & ea_count,
const infinint & total_ea,
void *context))
{
dar_manager_statistics_callback = callback;
set_use_dar_manager_statistics(true); // this is to inform libdar to use the dar_manager_statistics() method
};
void set_dar_manager_show_version_callback(void (*callback)(U_I number,
const std::string & data_date,
const std::string & data_presence,
const std::string & ea_date,
const std::string & ea_presence,
void *context))
{
dar_manager_show_version_callback = callback;
set_use_dar_manager_show_version(true); // this is to inform libdar to use the dar_manager_show_version() method
};
/// overwritting method from parent class.
virtual user_interaction *clone() const;
protected:
/// overwritting method from parent class.
void inherited_warning(const std::string & message);
private:
void (*warning_callback)(const std::string & x, void *context); // pointer to function
bool (*answer_callback)(const std::string & x, void *context); // pointer to function
std::string (*string_callback)(const std::string & x, bool echo, void *context); // pointer to function
secu_string (*secu_string_callback)(const std::string & x, bool echo, void *context); // pointer to function
void (*tar_listing_callback)(const std::string & flags,
const std::string & perm,
const std::string & uid,
const std::string & gid,
const std::string & size,
const std::string & date,
const std::string & filename,
bool is_dir,
bool has_children,
void *context);
void (*dar_manager_show_files_callback)(const std::string & filename,
bool available_data,
bool available_ea,
void *context);
void (*dar_manager_contents_callback)(U_I number,
const std::string & chemin,
const std::string & archive_name,
void *context);
void (*dar_manager_statistics_callback)(U_I number,
const infinint & data_count,
const infinint & total_data,
const infinint & ea_count,
const infinint & total_ea,
void *context);
void (*dar_manager_show_version_callback)(U_I number,
const std::string & data_date,
const std::string & data_presence,
const std::string & ea_date,
const std::string & ea_presence,
void *context);
void *context_val;
};
/// full implementation class for user_interaction, which shows nothing and assumes answer "no" to any question
class user_interaction_blind : public user_interaction
{
public:
bool pause2(const std::string & message) { return false; };
std::string get_string(const std::string & message, bool echo) { return "user_interaction_blind, is blindly answering no"; };
secu_string get_secu_string(const std::string & message, bool echo) { return secu_string(); };
user_interaction *clone() const { user_interaction *ret = new (std::nothrow) user_interaction_blind(); if(ret == NULL) throw Ememory("user_interaction_blind::clone"); return ret; };
protected:
void inherited_warning(const std::string & message) {}; // do not display any warning, this is "bind user_interaction" !
};
/// @}
} // end of namespace
#endif
|