libaegis/user.h

Go to the documentation of this file.

//
//      aegis - project change supervisor
//      Copyright (C) 1992-2000, 2002-2008 Peter Miller
//
//      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 3 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, see
//      <http://www.gnu.org/licenses/>.
//

#ifndef AEGIS_USER_H
#define AEGIS_USER_H

#include <common/ac/shared_ptr.h>

#include <common/nstring.h>
#include <libaegis/output.h>
#include <libaegis/uconf.h>
#include <libaegis/ustate.h>

class project_ty; // forward
class output_ty; // forward

class user_ty
{
public:
    typedef aegis_shared_ptr<user_ty> pointer;

    ~user_ty();

    static user_ty::pointer create();

private:
    user_ty();

public:
    static user_ty::pointer create(int uid);

private:
    user_ty(int uid);

public:
    static user_ty::pointer create(int uid, int gid);

private:
    user_ty(int uid, int gid);

public:
    static user_ty::pointer create(const nstring &login_name);

    static user_ty::pointer create_by_directory(const nstring &path);

    static void progress_option_set(void (*usage)(void));

    static void progress_option_clear(void (*usage)(void));

    bool progress_get();

    nstring name() const;

    nstring full_name() const;

    static nstring full_name(const nstring &login);

    int get_uid() const;

    bool check_uid() const;

    int get_gid() const;

    bool check_gid() const;

    nstring get_group_name() const;

    void set_gid(int gid, bool weak = false);

    void umask_set(int um);

    int umask_get() const;

    nstring get_home() const;

    nstring get_email_address();

    void ustate_write();

    void own_add(project_ty *pp, long chanum);

    bool own_nth(project_ty *pp, long n, long &chanum);

    void own_remove(project_ty *pp, long chanum);

    long default_change(project_ty *pp);

    nstring default_project();

    nstring default_development_directory(project_ty *pp);

    nstring default_project_directory();

    void become_begin();

    void become_end();

    class become
    {
    public:
        become(user_ty::pointer a_up) :
            up(a_up)
        {
            up->become_begin();
        }

        ~become()
        {
            up->become_end();
        }

    private:
        user_ty::pointer up;

        become(const become &);

        become &operator=(const become &);
    };

    bool delete_file_query(const nstring &filename, bool isdir,
        int default_preference);

    static void delete_file_argument(void (*usage)(void));

    void ustate_lock_prepare();

    static void lock_wait_argument(void(*usage)(void));

    bool lock_wait();

    nstring editor_command();

    nstring visual_command();

    uconf_diff_preference_ty diff_preference();

    bool pager_preference();

    nstring pager_command();

    bool persevere_preference(bool dflt);

    static void persevere_argument(void(*usage)(void));

    uconf_log_file_preference_ty log_file_preference(
        uconf_log_file_preference_ty dflt);

    static void relative_filename_preference_argument(void(*usage)(void));

    uconf_relative_filename_preference_ty relative_filename_preference(
        uconf_relative_filename_preference_ty dflt);

    static void symlink_pref_argument(void(*usage)(void));

    bool symlink_pref(bool proj_files_changed);

    static void whiteout_argument(void(*)(void));

    bool whiteout(int dflt = -1);

    void uconf_write_xml(output::pointer op);

    uconf_ty *uconf_get();

private:
    nstring login_name;

    nstring login_full_name;

    nstring home;

    nstring group_name;

    int user_id;

    int group_id;

    int umask;

    nstring ustate_path;

    ustate_ty *ustate_data;

    bool ustate_is_new;

    bool ustate_modified;

    ustate_ty *ustate_get(project_ty *pp);

    nstring uconf_path;

    uconf_ty *uconf_data;

    long lock_magic;

    void lock_sync();

    static size_t pool_nusers;

    static size_t pool_nusers_max;

    static pointer *pool_user;

    static user_ty::pointer pool_find(int uid);

    static void pool_add(user_ty::pointer up);

    void waiting_for_lock();

    static void waiting_for_lock(void *);
};


// use user_ty::create(int) instead
user_ty::pointer user_numeric(int uid) DEPRECATED;

// use user_ty::create(int, int) instead
user_ty::pointer user_numeric2(int uid, int gid) DEPRECATED;

// use user_ty::create(nstring) instead
user_ty::pointer user_symbolic(string_ty *login_name) DEPRECATED;

// use user_ty::create() instead
user_ty::pointer user_executing(void) DEPRECATED;

// use nothing at all
void user_free(user_ty::pointer) DEPRECATED;

// just assign it
user_ty::pointer user_copy(user_ty::pointer) DEPRECATED;

// use user_ty::name() instead
string_ty *user_name(user_ty::pointer up) DEPRECATED;

// use user_ty::full_name() instead
string_ty *user_name2(user_ty::pointer up) DEPRECATED;

// use user_ty::get_uid() instead
int user_id(user_ty::pointer) DEPRECATED;

// use user_ty::get_gid() instead
int user_gid(user_ty::pointer) DEPRECATED;

// use user_ty::umask_get() instead
int user_umask(user_ty::pointer) DEPRECATED;

// user user_ty::ustate_lock_prepare() instead
void user_ustate_lock_prepare(user_ty::pointer) DEPRECATED;

// use user_ty::get_group_name() instead
string_ty *user_group(user_ty::pointer) DEPRECATED;

// use user_ty::get_home() instead
string_ty *user_home(user_ty::pointer up) DEPRECATED;

// user user_ty::get_email_address() instead
string_ty *user_email_address(user_ty::pointer up) DEPRECATED;

// use user_ty::editor_command() instead
string_ty *user_editor_command(user_ty::pointer) DEPRECATED;

// user user_ty::visual_command() instead
string_ty *user_visual_command(user_ty::pointer) DEPRECATED;

// see user_ty::pager_command instead
string_ty *user_pager_command(user_ty::pointer) DEPRECATED;

// use user_ty::full_name(const nstring &) instead
string_ty *user_full_name(string_ty *) DEPRECATED;

// use user_ty::ustate_write() instead
void user_ustate_write(user_ty::pointer) DEPRECATED;

// use user_ty::own_add instead
void user_own_add(user_ty::pointer up, project_ty *pp, long chanum) DEPRECATED;

// use user_ty::own_nth instead
int user_own_nth(user_ty::pointer up, project_ty *oo, long n, long *chanum_p)
    DEPRECATED;

// use user_ty::own_remove instead
void user_own_remove(user_ty::pointer up, project_ty *pp, long chanum)
    DEPRECATED;

// use user_ty::default_change(project_ty *pp) instead
long user_default_change(user_ty::pointer up, project_ty *pp) DEPRECATED;

// user user_ty::default_project() instead
string_ty *user_default_project_by_user(user_ty::pointer) DEPRECATED;

// user user_ty::default_project() instead
string_ty *user_default_project(void) DEPRECATED;

// use user_ty::default_development_directory(project_ty *pp) instead
string_ty *user_default_development_directory(user_ty::pointer up,
    project_ty *pp) DEPRECATED;

// user user_ty::default_project_directory() instead
string_ty *user_default_project_directory(user_ty::pointer) DEPRECATED;

// use user_ty::become_begin() instead
void user_become(user_ty::pointer) DEPRECATED;

// use user_ty::become_end() instead
void user_become_undo(void) DEPRECATED;

// use user_ty::delete_file_query instead
bool user_delete_file_query(user_ty::pointer up, string_ty *filename,
    bool isdir, int default_preference) DEPRECATED;

// use user_ty::delete_file_argument instead
void user_delete_file_argument(void (*)(void)) DEPRECATED;

// use user_ty::diff_preference() instead
int user_diff_preference(user_ty::pointer) DEPRECATED;

// use user_ty::pager_preference() instead
int user_pager_preference(user_ty::pointer) DEPRECATED;

// use user_ty::persevere_preference() instead
int user_persevere_preference(user_ty::pointer, int) DEPRECATED;

// use user_ty::persevere_argument instead
void user_persevere_argument(void(*)(void)) DEPRECATED;

// use user_ty::log_file_preference instead
uconf_log_file_preference_ty user_log_file_preference(user_ty::pointer,
    uconf_log_file_preference_ty) DEPRECATED;

// user user_ty::lock_wait_argument instead
void user_lock_wait_argument(void(*usage)(void)) DEPRECATED;

// user user_ty::lock_wait instead
int user_lock_wait(user_ty::pointer up) DEPRECATED;

// use user_ty::whiteout_argument instead
void user_whiteout_argument(void(*)(void)) DEPRECATED;

// use user_ty::whiteout instead
int user_whiteout(user_ty::pointer up, int dflt = -1) DEPRECATED;

// use user_ty::symlink_pref_argument instead
void user_symlink_pref_argument(void(*)(void)) DEPRECATED;

// use user_ty::symlink_pref instead
int user_symlink_pref(user_ty::pointer, int) DEPRECATED;

// use user_ty::relative_filename_preference_argument instead
void user_relative_filename_preference_argument(void(*)(void)) DEPRECATED;

// use user_ty::relative_filename_preference instead
uconf_relative_filename_preference_ty user_relative_filename_preference(
    user_ty::pointer, uconf_relative_filename_preference_ty) DEPRECATED;

// use user_ty::uconf_write_xml instead
void user_uconf_write_xml(user_ty::pointer, output::pointer) DEPRECATED;

// use user_ty::uconf_get() instead
uconf_ty *user_uconf_get(user_ty::pointer) DEPRECATED;

#endif // AEGIS_USER_H

---