---

PasswordCodecPrototype.h

Go to the documentation of this file.

/*!
 * \file PasswordCodecPrototype.h
 * \brief Defines the password encoding/decoding prototype
 *
 * \author Frederic RUAUDEL <grumz@users.sf.net>
 *
 * $Revision: 1.12 $
 * $Date: 2003/03/08 09:56:11 $
 *
 * \b PassGuardFramework
 * Copyleft (c) 2002 Frederic RUAUDEL, all rights reversed
 *
 * This program is free software which I release under the GNU General Public
 * License. You may redistribute and/or modify this program under the terms
 * of that 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.  Version 2 is in the
 * COPYING file in the top level directory of this distribution.
 *
 * To get a copy of the GNU General Public License, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **/

#ifndef PASSWORD_CODEC_PROTOTYPE_H
#define PASSWORD_CODEC_PROTOTYPE_H

#include <stdio.h>
#include <unistd.h>
#include <errno.h>

#include <list>
#include <string>
#include <map>

#include <PasswordInfos.h>
#include <PassguardErrorManager.h>

using namespace std;

/*!
 * \brief Password encoding/decoding prototype
 **/
class PasswordCodecPrototype : public PassguardErrorManager
{
        public:
                virtual ~PasswordCodecPrototype ();

                virtual PasswordCodecPrototype* clone (void) const = 0;

                virtual bool loadFile (string filename, string password) = 0;
                virtual bool saveFile (string password) = 0;

                virtual bool loadDefaultFile (string password);
                virtual bool saveFileAs (string filename, string password);
                virtual bool newFile (string filename, string password);

                virtual bool hasDefaultFilename (void);
                virtual string getDefaultFilename (void);
                virtual string getCurrentFilename (void);
                virtual bool setFilenameToDefault (void);

                virtual PasswordInfos* popPasswordInfos (void);
                virtual bool pushPasswordInfos (PasswordInfos* password_infos);

                virtual bool isEditable (void);
                virtual bool getEditability (void);
                virtual void releaseEditability (void);

                virtual bool isModified (void) const;

                virtual bool hasFixedField (void) const = 0;
                virtual int getNbField (void) const = 0;
                virtual PasswordInfos getFieldsName (void) const = 0;
                virtual bool setFieldsName (PasswordInfos fields_name_infos) = 0;

        protected:
                PasswordCodecPrototype ();
                PasswordCodecPrototype (const PasswordCodecPrototype& password_codec_prototype);

                list<PasswordInfos*> _password_infos_list;
                string _filename;
                bool _is_modified;
                bool _is_editable;
                bool _is_edited;
                string _default_filename;
};

/*!
 * \fn PasswordCodecPrototype* PasswordCodecPrototype::clone (void) const = 0
 *
 * \brief Create a new password encoding/decoding prototype that is a exact 
 *              copy of the current one
 *
 * \return the new password encoding/decoding prototype clone
 **/

/*!
 * \fn bool PasswordCodecPrototype::loadFile (string filename, string password) = 0
 *
 * \brief Decrypts the password informations and add them in the list in
 *      order they can be retreived by the app
 *
 * \param filename the filename where encrypted passwords are.
 * \param password the password to decrypt the file
 *
 * \return true if the decryption is ok / false otherwise
 **/

/*!
 * \fn bool PasswordCodecPrototype::saveFile (string password) = 0
 * 
 * \brief Encrypts and saves all the password informations present in the list 
 *              in the file defined by loadFile() or newFile()
 *
 * \param password the password to encrypt the data
 *
 * \return true if the save succeeds / false otherwise
 **/

/*!
 * \fn bool PasswordCodecPrototype::hasFixedField (void) const = 0
 *
 * \brief Defines if this encrypted format supports variable number of field to describe passwords
 *
 * \return true if the number is fixed / false if it is variable
 **/

/*!
 * \fn int PasswordCodecPrototype::getNbField (void) const = 0
 *
 * \brief Returns the number of fields that describe the password (password and description are not included)
 *
 * \return the number of fields
 **/

/*!
 * \fn PasswordInfos PasswordCodecPrototype::getFieldsName (void) const = 0
 *
 * \brief Returns the fields name describing what represents each elements of 
 *              the password informations
 *
 * \return a PasswordInfos structure in which each element holds the name 
 *              of fields
 **/

/*!
 * \fn void PasswordCodecPrototype::setFieldsName (PasswordInfos fields_name_infos) = 0
 *
 * \brief Defines the fields name describing what represents each elements of 
 *              the password informations
 *
 * \param fields_name_infos a PasswordInfos structure in which each element holds 
 *              the name of fields
 *
 * \return true if formats of PasswordInfos structures are compatible / false otherwise.
 **/

#endif /* PASSWORD_CODEC_PROTOTYPE_H */

---