---

freedb.hxx

/*
    \todo Setup a sourceforge account.

    \todo Application layer errors (6xx), e.g. "need connection first"

    \todo Connection checker guard

    \todo Central error handling for general errors
*/

#ifndef FREEDB_HXX
#define FREEDB_HXX

#include <assert.h>

#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>
#include <unistd.h> //close()
#include <errno.h>
#include <linux/cdrom.h>

#include <string.h> //strerror()

#include <iostream>
#include <sstream>
#include <string>
#include <vector>

inline int stoi(const string s)
{
    istringstream in(s);
    int i;

    in >> i;

    return(i);
}

inline string itos(int i)
{
    ostringstream out;

    out << i;

    return(out.str());
}

const unsigned short CDDBP_PORT = 8880;


typedef struct
{
    string leading;
    string version_number;
    string release_type;
    string level;
} ClientVersion;

typedef struct
{
    string name;
    ClientVersion version;
    string comments;
} ClientInfo;

typedef struct
{
    long discid;                    
    string dartist;                 
    string dtitle;                  
    string dyear;                   
    string dgenre;                  
    string dextinfo;                
    int revision;                   
    vector<int> trackoffsets;       
    vector<string> tracktitles;     
    vector<int> playorder;          
} CDInfo;

typedef struct
{
    long discid;
    string category;
    string dartist;
    string dtitle;
} SearchResult;

typedef struct
{
    string compassdirection;
    short degrees;
    short minutes;
} GeoCoords;

typedef struct
{
    string site;
    unsigned short port;
    GeoCoords latitude;
    GeoCoords longitude;
    string description;
} ServerInfo;

typedef struct
{
    int min;
    int sec;
    int frame;
} TrackPosition;

typedef struct
{
    int errcode;
    string errmsg;
    int errcode_sys;
    string errmsg_sys;
    string extinfo;
} Error;

class Freedb
{
    public:

        virtual vector<SearchResult> search() const = 0;

        static string createEntry(CDInfo info);
        static CDInfo parseEntry(string entry);

        static vector<TrackPosition> getTrackOffsets(string device = "/dev/cdrom");

        static unsigned long generateDiscID(const vector<TrackPosition> offsets, const int num_tracks);
        static unsigned long getDiscID(string device = "/dev/cdrom");

        static void createDefaultDirectories();

    private:
        static int generateDiscSum(int n);
};

class FreedbRemote : public Freedb
{
    public:
        FreedbRemote(string servername = "freedb.freedb.org");
        ~FreedbRemote();

        vector<SearchResult> search() const;

        void doHandshake(string username, string clientname, string version) const;

        vector<ServerInfo> getServerList() const;

        vector<string> getCategories() const;

        void submitDiscInfo(CDInfo info) const;

        inline string getGreeting() const
        {
            return(_greeting);
        }

    protected:
        void connect(string servername = "freedb.freedb.org");
        void disconnect();

        void sendCommand(string command) const;
        string getResponseLine(bool stripcr = true) const;
        static ServerInfo parseServerInfoLine(string line);

        int _sockfd;
        string _greeting;
};

class FreedbLocal : public Freedb
{
    public:
        FreedbLocal(string dbfilename = "~/.freedb/db");
        ~FreedbLocal();

        vector<SearchResult> search() const;

    protected:
        int _dbfd;
};

#endif



/*
General errors:
---------------

Server response:
<- code error
    code:
402Server error.
408CGI environment error.
500Command syntax error, command unknown, command unimplemented.
530Server error, server timeout.

freedb query:
-----------
Client command:
-> freedb query discid ntrks off1 off2 ... nsecs

    discid:
CD disc ID number.  Example: f50a3b13
    ntrks:
Total number of tracks on CD.
    off1, off2, ...:
Frame offset of the starting location of each track.
    nsecs:
Total playing length of CD in seconds (calculated by dividing the lead
out offset in frames by 75 (discarding the remainder)).

Server response:
<- code categ discid dtitle
or
<- code close matches found
<- categ discid dtitle
<- categ discid dtitle
<- (more matches...)
<- .

    code:
200 Found exact match
211 Found inexact matches, list follows (until terminating marker)
202 No match found
403 Database entry is corrupt
409 No handshake
    categ:
CD category.  Example: rock
    discid:
CD disc ID number of the found entry.  Example: f50a3b13
    dtitle:
The Disc Artist and Disc Title (The DTITLE line).  For example:
Pink Floyd / The Dark Side of the Moon


freedb read:
----------
Client command:
-> freedb read categ discid

    categ:
CD category.  Example: rock
    discid:
CD disc ID number.  Example: f50a3b13

Server response:
<- code categ discid
<- # xmcd 2.0 CD database file
<- # ...
<- (freedb data...)
<- .
or
<- code categ discid No such CD entry in database

    code:
210 OK, freedb database entry follows (until terminating marker)
401 Specified freedb entry not found.
402 Server error.
403 Database entry is corrupt.
409 No handshake.
    categ:
CD category.  Example: rock
    discid:
CD disc ID number.  Example: f50a3b13


freedb write:
-----------
Client command:
-> freedb write categ discid

    categ:
CD category.  Example: rock
    discid:
CD disc ID number.  Example: f50a3b13

Server response:
<- code categ discid

    code:
320OK, input freedb data (until terminating marker)
401Permission denied.
402Server file system full/file access failed.
409No handshake.
501Entry rejected: reason for rejection.
    categ:
CD category.  Example: rock
    discid:
CD disc ID number.  Example: f50a3b13

Client data:
-> # xmcd 2.0 CD database file
-> # ...
-> (freedb data)
-> .

Server response:
<- code message

    code:
200 freedb entry accepted
401 freedb entry rejected: reason why
    message:
Message string to indicate write status:
freedb entry accepted, or freedb entry rejected.
*/

---