File

Data Structures
struct	GSM_FileSystemStatus
struct	GSM_File

Enumerations
enum	GSM_FileType {   GSM_File_Other = 1, GSM_File_Java_JAR, GSM_File_Image_JPG, GSM_File_Image_BMP,   GSM_File_Image_GIF, GSM_File_Image_PNG, GSM_File_Image_WBMP, GSM_File_Video_3GP,   GSM_File_Sound_AMR, GSM_File_Sound_NRT, GSM_File_Sound_MIDI, GSM_File_MMS,   GSM_File_INVALID }

Functions
GSM_Error	GSM_JADFindData (GSM_File *File, char *Vendor, char *Name, char *JAR, char *Version, int *Size)
GSM_Error	GSM_ReadFile (const char *FileName, GSM_File *File)
void	GSM_IdentifyFileFormat (GSM_File *File)
GSM_Error	GSM_GetNextFileFolder (GSM_StateMachine *s, GSM_File *File, gboolean start)
GSM_Error	GSM_GetFolderListing (GSM_StateMachine *s, GSM_File *File, gboolean start)
GSM_Error	GSM_GetNextRootFolder (GSM_StateMachine *s, GSM_File *File)
GSM_Error	GSM_SetFileAttributes (GSM_StateMachine *s, GSM_File *File)
GSM_Error	GSM_GetFilePart (GSM_StateMachine *s, GSM_File *File, int *Handle, size_t *Size)
GSM_Error	GSM_AddFilePart (GSM_StateMachine *s, GSM_File *File, size_t *Pos, int *Handle)
GSM_Error	GSM_SendFilePart (GSM_StateMachine *s, GSM_File *File, size_t *Pos, int *Handle)
GSM_Error	GSM_GetFileSystemStatus (GSM_StateMachine *s, GSM_FileSystemStatus *Status)
GSM_Error	GSM_DeleteFile (GSM_StateMachine *s, unsigned char *ID)
GSM_Error	GSM_AddFolder (GSM_StateMachine *s, GSM_File *File)
GSM_Error	GSM_DeleteFolder (GSM_StateMachine *s, unsigned char *ID)

Detailed Description

Files handling.

Enumeration Type Documentation

GSM_FileType

enum GSM_FileType

File type identifier.

Enumerator
GSM_File_Other
GSM_File_Java_JAR
GSM_File_Image_JPG
GSM_File_Image_BMP
GSM_File_Image_GIF
GSM_File_Image_PNG
GSM_File_Image_WBMP
GSM_File_Video_3GP
GSM_File_Sound_AMR
GSM_File_Sound_NRT	DCT4 binary format
GSM_File_Sound_MIDI
GSM_File_MMS
GSM_File_INVALID

Definition at line 41 of file gammu-file.h.

             {
        GSM_File_Other = 1,
        GSM_File_Java_JAR,
        GSM_File_Image_JPG,
        GSM_File_Image_BMP,
        GSM_File_Image_GIF,
        GSM_File_Image_PNG,
        GSM_File_Image_WBMP,
        GSM_File_Video_3GP,
        GSM_File_Sound_AMR,
        GSM_File_Sound_NRT,
        GSM_File_Sound_MIDI,
        GSM_File_MMS,

        GSM_File_INVALID
} GSM_FileType;

Function Documentation

GSM_AddFilePart()

GSM_Error GSM_AddFilePart	(	GSM_StateMachine *	s,
		GSM_File *	File,
		size_t *	Pos,
		int *	Handle
	)

Adds file to filesystem. Call repeatedly until function returns ERR_EMPTY.

Parameters

s	State machine pointer.
File	File structure and data.
Pos	Position of transmitted data. Should be 0 on start.
Handle	Handle for saving file, some drivers need this information to be kept between function calls.

Returns

Error code, ERR_EMPTY after transfer end.

Adds file part to filesystem.

Definition at line 1765 of file api.c.

References GSM_Phone_Functions::AddFilePart, CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->AddFilePart(s, File, Pos, Handle);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_AddFolder()

GSM_Error GSM_AddFolder	(	GSM_StateMachine *	s,
		GSM_File *	File
	)

Adds folder to filesystem.

Parameters

s	State machine pointer.
File	Structure containing information about new folder (Name and FullName).

Returns

Error code.

Adds folder to filesystem.

Definition at line 1817 of file api.c.

References GSM_Phone_Functions::AddFolder, CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->AddFolder(s, File);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_DeleteFile()

GSM_Error GSM_DeleteFile	(	GSM_StateMachine *	s,
		unsigned char *	ID
	)

Deletes file from filesystem.

Parameters

s	State machine pointer.
ID	ID of folder.

Returns

Error code.

Deletes file from filessytem.

Definition at line 1804 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone_Functions::DeleteFile, GSM_Phone::Functions, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->DeleteFile(s, ID);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_DeleteFolder()

GSM_Error GSM_DeleteFolder	(	GSM_StateMachine *	s,
		unsigned char *	ID
	)

Deletes folder from filesystem.

Parameters

s	State machine pointer.
ID	ID of folder.

Returns

Error code.

Deletes folder from filesystem.

Definition at line 1830 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone_Functions::DeleteFolder, GSM_Phone::Functions, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->DeleteFolder(s, ID);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetFilePart()

GSM_Error GSM_GetFilePart	(	GSM_StateMachine *	s,
		GSM_File *	File,
		int *	Handle,
		size_t *	Size
	)

Retrieves file part.

Parameters

s	State machine pointer.
File	File structure with path, data will be stored here.
Size	Size of transmitted data.
Handle	Handle for saving file, some drivers need this information to be kept between function calls.

Returns

Error code, ERR_EMPTY after transfer end.

Retrieves file part.

Definition at line 1752 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetFilePart, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetFilePart(s, File, Handle, Size);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetFileSystemStatus()

GSM_Error GSM_GetFileSystemStatus	(	GSM_StateMachine *	s,
		GSM_FileSystemStatus *	Status
	)

Acquires filesystem status.

Parameters

s	State machine pointer.
Status	Storage for status information.

Returns

Error code.

Acquires filesystem status.

Definition at line 1791 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetFileSystemStatus, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetFileSystemStatus(s, Status);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetFolderListing()

GSM_Error GSM_GetFolderListing	(	GSM_StateMachine *	s,
		GSM_File *	File,
		gboolean	start
	)

Gets listing of folder.

Parameters

s	State machine pointer.
File	File structure where path will be stored, if start is FALSE, it should contain data from previous reading (at least ID). On start it should contain path to directory.
start	Whether we're starting transfer.

Returns

Error code.

Gets file part from filesystem.

Definition at line 1712 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetFolderListing, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and PRINT_START.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_START();

        err = s->Phone.Functions->GetFolderListing(s, File, start);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetNextFileFolder()

GSM_Error GSM_GetNextFileFolder	(	GSM_StateMachine *	s,
		GSM_File *	File,
		gboolean	start
	)

Gets next filename from filesystem.

Parameters

s	State machine pointer.
File	File structure where path will be stored, if start is FALSE, it should contain data from previous reading (at least ID).
start	Whether we're starting transfer.

Returns

Error code.

Gets next filename from filesystem.

Definition at line 1698 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetNextFileFolder, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and PRINT_START.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_START();

        err = s->Phone.Functions->GetNextFileFolder(s, File, start);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetNextRootFolder()

GSM_Error GSM_GetNextRootFolder	(	GSM_StateMachine *	s,
		GSM_File *	File
	)

Gets next root folder.

Parameters

s	State machine pointer.
File	File structure where path will be stored.

Returns

Error code.

Gets next root folder.

Definition at line 1726 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetNextRootFolder, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetNextRootFolder(s, File);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_IdentifyFileFormat()

void GSM_IdentifyFileFormat

(

GSM_File *

File

)

Identifies file format by checking it's content.

Parameters

File	File data, Type member will be filled in.

Definition at line 164 of file gsmmisc.c.

References GSM_File::Buffer, GSM_File_Image_BMP, GSM_File_Image_GIF, GSM_File_Image_JPG, GSM_File_Image_PNG, GSM_File_Image_WBMP, GSM_File_Other, GSM_File_Sound_MIDI, GSM_File_Sound_NRT, PRINTF_STYLE, GSM_File::Type, and GSM_File::Used.

Referenced by GSM_ReadFile().

{
        File->Type = GSM_File_Other;
        if (File->Used > 2) {
                if (memcmp(File->Buffer, "BM",2)==0) {
                        File->Type = GSM_File_Image_BMP;
                } else if (memcmp(File->Buffer, "GIF",3)==0) {
                        File->Type = GSM_File_Image_GIF;
                } else if (File->Buffer[0] == 0x00 && File->Buffer[1] == 0x00) {
                        File->Type = GSM_File_Image_WBMP;
                } else if (memcmp(File->Buffer+1, "PNG",3)==0) {
                        File->Type = GSM_File_Image_PNG;
                } else if (File->Buffer[0] == 0xFF && File->Buffer[1] == 0xD8) {
                        File->Type = GSM_File_Image_JPG;
                } else if (memcmp(File->Buffer, "MThd",4)==0) {
                        File->Type = GSM_File_Sound_MIDI;
                } else if (File->Buffer[0] == 0x00 && File->Buffer[1] == 0x02) {
                        File->Type = GSM_File_Sound_NRT;
                }
        }
}

GSM_JADFindData()

GSM_Error GSM_JADFindData	(	GSM_File *	File,
		char *	Vendor,
		char *	Name,
		char *	JAR,
		char *	Version,
		int *	Size
	)

Parses JAD file.

Parameters

File	JAD file data.
Vendor	Buffer for vendor name.
Name	Buffer for application name.
JAR	Buffer for JAR URL.
Version	Buffer for version of application.
Size	Pointer to integer to store size.

Returns

Error code.

Definition at line 136 of file gsmmisc.c.

References dbgprintf, ERR_FILENOTSUPPORTED, ERR_NONE, and GSM_JADFindLine().

{
        char Size2[200];

        GSM_JADFindLine(File, "MIDlet-Vendor:", Vendor);
        if (Vendor[0] == 0x00) return ERR_FILENOTSUPPORTED;
        dbgprintf(NULL, "Vendor: \"%s\"\n",Vendor);

        GSM_JADFindLine(File, "MIDlet-Name:", Name);
        if (Name[0] == 0x00) return ERR_FILENOTSUPPORTED;
        dbgprintf(NULL, "Name: \"%s\"\n",Name);

        GSM_JADFindLine(File, "MIDlet-Jar-URL:", JAR);
        if (JAR[0] == 0x00) return ERR_FILENOTSUPPORTED;
        dbgprintf(NULL, "JAR file URL: \"%s\"\n",JAR);

        GSM_JADFindLine(File, "MIDlet-Jar-Size:", Size2);
        *Size = -1;
        if (Size2[0] == 0x00) return ERR_FILENOTSUPPORTED;
        dbgprintf(NULL, "JAR size: \"%s\"\n",Size2);
        (*Size) = atoi(Size2);

        GSM_JADFindLine(File, "MIDlet-Version:", Version);
        dbgprintf(NULL, "Version: \"%s\"\n",Version);

        return ERR_NONE;
}

GSM_ReadFile()

GSM_Error GSM_ReadFile	(	const char *	FileName,
		GSM_File *	File
	)

Reads file from filesystem to GSM_File structure.

Parameters

FileName	File to read.
File	Storage for data.

Returns

Error code.

Definition at line 74 of file gsmmisc.c.

References GSM_File::Buffer, dbgprintf, ERR_CANTOPENFILE, ERR_NONE, ERR_UNKNOWN, FALSE, Fill_GSM_DateTime(), GSM_File::Folder, GSM_IdentifyFileFormat(), GSM_File::Hidden, GSM_File::Level, GSM_File::Modified, GSM_File::ModifiedEmpty, OSDate(), GSM_File::Protected, GSM_File::ReadOnly, GSM_File::System, TRUE, and GSM_File::Used.

Referenced by DUMMY_GetFilePart(), and PHONE_FindDataFile().

{
        int             i = 1000;
        FILE            *file;
        struct stat     fileinfo;

        if (FileName[0] == 0x00) return ERR_UNKNOWN;
        file = fopen(FileName,"rb");
        if (file == NULL) return ERR_CANTOPENFILE;

        free(File->Buffer);
        File->Buffer    = NULL;
        File->Used      = 0;
        while (i == 1000) {
                File->Buffer    = (unsigned char *)realloc(File->Buffer,File->Used + 1000);
                i               = fread(File->Buffer+File->Used,1,1000,file);
                File->Used      = File->Used + i;
        }
        File->Buffer = (unsigned char *)realloc(File->Buffer,File->Used + 1);
        /* Make it 0 terminated, in case it is needed somewhere (we don't count this to length) */
        File->Buffer[File->Used] = 0;
        fclose(file);

        File->Level = 0;
        GSM_IdentifyFileFormat(File);
        File->Protected = FALSE;
        File->Hidden = FALSE;
        File->System = FALSE;
        File->ReadOnly = FALSE; /* @todo TODO get this from permissions? */
        File->Folder = FALSE;

        File->ModifiedEmpty = TRUE;
        if (stat(FileName,&fileinfo) == 0) {
                File->ModifiedEmpty = FALSE;
                dbgprintf(NULL, "File info read correctly\n");
                /* st_mtime is time of last modification of file */
                Fill_GSM_DateTime(&File->Modified, fileinfo.st_mtime);
                dbgprintf(NULL, "FillTime: %s\n", OSDate(File->Modified));
        }

        return ERR_NONE;
}

GSM_SendFilePart()

GSM_Error GSM_SendFilePart	(	GSM_StateMachine *	s,
		GSM_File *	File,
		size_t *	Pos,
		int *	Handle
	)

Sends file to phone, it's up to phone to decide what to do with it. It is usually same as when you receive file over Bluetooth from other phone. Use in same way as GSM_AddFilePart.

Parameters

s	State machine pointer.
File	File structure and data.
Pos	Position of transmitted data. Should be 0 on start.
Handle	Handle for saving file, some drivers need this information to be kept between function calls.

Returns

Error code, ERR_EMPTY after transfer end.

Sends file to phone, it's up to phone to decide what to do with it.

Definition at line 1778 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and GSM_Phone_Functions::SendFilePart.

Referenced by PHONE_UploadFile().

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->SendFilePart(s, File, Pos, Handle);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_SetFileAttributes()

GSM_Error GSM_SetFileAttributes	(	GSM_StateMachine *	s,
		GSM_File *	File
	)

Sets file system attributes.

Parameters

s	State machine pointer.
File	File structure with path and attributes.

Returns

Error code.

Sets file system attributes.

Definition at line 1739 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and GSM_Phone_Functions::SetFileAttributes.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->SetFileAttributes(s, File);
        PRINT_LOG_ERROR(err);
        return err;
}