erbrowser/src/indexFileHandler.cpp File Reference

#include <stdio.h>
#include "expat.h"
#include "browserTypes.h"
#include "indexFileHandler.h"
#include "browserLog.h"
#include <libermanifest/ermanifest.h>

Go to the source code of this file.

Defines
#define	BUFFER_SIZE   256
#define	MAX_LEN   1024
#define	INDEX_DEBUG   0
#define	TRACE(x...)   do {} while(0)
Functions
static int	contain_url (const char *first, const char *second)
int	get_pagelist_length (erManifest *manifest)
PageListItem *	pageListItem_create (erManifest *manifest, const int index)
void	pageInfo_release (PageInfo *pInfo)
void	pageListItem_release (PageListItem *pItem)
void	index_file_close (IndexInfo *index)
int	index_file_init (const char *pathName, IndexInfo *pIndex)
int	index_file_get_page_count (IndexInfo *index, const char *type)
int	index_file_get_page_number (IndexInfo *index, const char *type, const char *url)
char *	index_file_get_page_location (IndexInfo *index, const char *type, const int number)
void	dump (IndexInfo *index)

---

Define Documentation

#define BUFFER_SIZE   256

Definition at line 37 of file indexFileHandler.cpp.

#define INDEX_DEBUG   0

Definition at line 39 of file indexFileHandler.cpp.

#define MAX_LEN   1024

Definition at line 38 of file indexFileHandler.cpp.

#define TRACE

(

x...

)

do {} while(0)

Definition at line 44 of file indexFileHandler.cpp.

---

Function Documentation

static int contain_url	(	const char *	first,
		const char *	second
	)			[static]

Definition at line 575 of file indexFileHandler.cpp.

{
    if (NULL == first || NULL == second) return 1;
    int len1   = strlen(first), len2 = strlen(second);
    int min    = len1; 
    if (min > len2) min = len2;
    
    first += len1; second += len2;
    for(int i = 0; i <min; ++i)
    {
        if (*first-- != *second--) 
        {
            return 0;
        }
    }
    return 1;
}

void dump

(

IndexInfo *

index

)

Dump IndexInfo information, for debug

Parameters:

IndexInfo

reference to the current inde file

Returns:

void

Definition at line 830 of file indexFileHandler.cpp.

{
    if (NULL == index) return;
    
    printf("=======================Index file information=======================\n");
    printf("length %d\n", index->length);
    for(int i = 0; i <index->length; ++i)
    {
        PageListItem *pItem = index->pagelist[i];
        printf("\titem type: %s\tcount: %d\n", pItem->type, pItem->count);
        
        for(int j = 0; j < pItem->count; ++j)
        {
            PageInfo *pInf = pItem->page[j];
            printf("\t\tpage number: %d\turl: %s\n", pInf->number, pInf->url);
        }
    }
    printf("====================================================================\n");
}    

int get_pagelist_length

(

erManifest *

manifest

)

Definition at line 594 of file indexFileHandler.cpp.

{
    char xpath[MAX_LEN]  = {0};
    char type[MAX_LEN]   = {0};
    int i = 0;
    int ret = RET_OK;
    while (1)
    {
        snprintf(xpath, MAX_LEN, "/package/index/pagelist[%d]", i + 1);
        ret = ermXmlGetAttributeString(manifest, xpath, "type", type, MAX_LEN);
        if (RET_ERR == ret) break;
        ++i;
    }
    return i;
}

Here is the call graph for this function:

void index_file_close

(

IndexInfo *

index

)

Close the index/manifest file

Parameters:

IndexInfo

pointer

Returns:

-

Definition at line 678 of file indexFileHandler.cpp.

{
    if (NULL == index)
    {
        TRACE("Invalid IndexInfo pointer!");
        return;
    }
    
    if (NULL == index->pagelist || 0 >= index->length)
    {
        // not initialized
        return;
    }
    
    // release all memory
    for(int i = 0; i < index->length; ++i)
    {
        pageListItem_release(index->pagelist[i]);
    }
    free(index->pagelist);
}

Here is the call graph for this function:

int index_file_get_page_count	(	IndexInfo *	index,
		const char *	type
	)

Retrieve the page count from the index file, given the page type

Parameters:

	FILE	reference to the current inde file
	type	page type

Returns:

pagecount (DEFAULT_PAGE_COUNT in case of error)

Definition at line 733 of file indexFileHandler.cpp.

{
    if (NULL == index)
    {
        TRACE("Invalid index pointer!");
        return INVALID_PAGE_COUNT;
    }
    
    if (NULL == type)
    {
        TRACE("Invalid type pointer!");
        return INVALID_PAGE_COUNT;
    }
    
    for(int i = 0; i < index->length; ++i)
    {
        if (0 == strcmp(index->pagelist[i]->type, type))
        {
            return index->pagelist[i]->count;
        }
    }
    return INVALID_PAGE_COUNT;
}

char* index_file_get_page_location	(	IndexInfo *	index,
		const char *	type,
		const int	number
	)

Retrieve the page number from the index file, given the page type and the url

Parameters:

	IndexInfo	reference to the current inde file
	type	page type
	number	page number

Returns:

url (allocated memory should be freed by the calling routine)

Definition at line 798 of file indexFileHandler.cpp.

{
    if (NULL == index)
    {
        TRACE("Invalid index pointer!");
        return NULL;
    }
    
    if (NULL == type)
    {
        TRACE("Invalid type pointer!");
        return NULL;
    }

    
    for(int i = 0; i < index->length; ++i)
    {
        if (0 == strcmp(index->pagelist[i]->type, type))
        {
            PageListItem *pItem = index->pagelist[i];
            for(int j = 0; j < pItem->count; ++j)
            {
                if (number == pItem->page[j]->number)
                {
                    return pItem->page[j]->url;
                }
            }
        }
    }
    return NULL;
}

int index_file_get_page_number	(	IndexInfo *	index,
		const char *	type,
		const char *	url
	)

Retrieve the page number from the index file, given the page type and the url

Parameters:

	IndexInfo	reference to the current index struct
	type	page type
	url	page url

Returns:

pagenumber

Definition at line 760 of file indexFileHandler.cpp.

{
    if (NULL == index)
    {
        TRACE("Invalid index pointer!");
        return INVALID_PAGE_COUNT;
    }
    
    if (NULL == type)
    {
        TRACE("Invalid type pointer!");
        return INVALID_PAGE_COUNT;
    }
    
    if (NULL == url)
    {
        TRACE("Invalid url pointer!");
        return INVALID_PAGE_COUNT;
    }
   
    for(int i = 0; i < index->length; ++i)
    {
        if (0 == strcmp(index->pagelist[i]->type, type))
        {
            PageListItem *pItem = index->pagelist[i];
            for(int j = 0; j < pItem->count; ++j)
            {
                // should use contain_url. 
                if (contain_url(url, pItem->page[j]->url))
                {
                    return pItem->page[j]->number;
                }
            }
        }
    }
    return INVALID_PAGE_NMBR;
}

Here is the call graph for this function:

int index_file_init	(	const char *	file,
		IndexInfo *	index
	)

Open the index/manifest file

Parameters:

file

name

Returns:

non zero in case of error

Definition at line 700 of file indexFileHandler.cpp.

{
    pIndex->pagelist  = NULL;
    pIndex->length    = 0;
    erManifest manifest;
    if (RET_OK != ermXmlOpenFile(pathName, &manifest))
    {
        TRACE("Could not open manifest file %s", pathName);
        return -1;
    }
    
    pIndex->length    = get_pagelist_length(&manifest);
    if (0 >= pIndex->length)
    {
        TRACE("No Pagelist item!");
        return 0;
    }
    
    // construct one by one
    pIndex->pagelist = (PageListItem **)malloc(pIndex->length * sizeof(PageListItem *));
    for(int i = 0; i < pIndex->length; ++i)
    {
        pIndex->pagelist[i] = pageListItem_create(&manifest, i + 1);
    }
    ermXmlClose(&manifest);
    
#if (INDEX_DEBUG)
    dump(pIndex);
#endif
    
    return 0;
}

Here is the call graph for this function:

void pageInfo_release

(

PageInfo *

pInfo

)

Definition at line 653 of file indexFileHandler.cpp.

{
    if (pInfo->url)
    {
        free(pInfo->url);
        pInfo->url = NULL;
    }
    pInfo->number = INVALID_PAGE_NMBR;
}

PageListItem* pageListItem_create	(	erManifest *	manifest,
		const int	index
	)

Definition at line 611 of file indexFileHandler.cpp.

{
    char url[MAX_LEN]    = {0};
    char type[MAX_LEN]   = {0};
    char xpath[MAX_LEN]  = {0};
    int ret = RET_OK;
    int count = 0;
    
    snprintf(xpath, MAX_LEN, "/package/index/pagelist[%d]", index);
    ret = ermXmlGetAttributeString(manifest, xpath, "type", type, MAX_LEN);
    ret = ermXmlGetAttributeInt(manifest, xpath, "count", &count);
    if (RET_ERR == ret) 
    {
        TRACE("Could not read attribute!");
        return NULL;
    }
  
    // init page List Item, count and type
    PageListItem *pItem = (PageListItem *)malloc(sizeof(PageListItem));
    pItem->type = (char *)malloc(strnlen(type, MAX_LEN) + 1);
    strcpy(pItem->type, type);
    pItem->type[strlen(pItem->type)] = 0;
    pItem->count = count;
    pItem->page  = (PageInfo **)malloc(sizeof(PageInfo *) * count);

    // construct PageInfo array
    for(int i = 1; i <= pItem->count; ++i)
    {
        // two tags : url and number
        snprintf(xpath, MAX_LEN, "/package/index/pagelist[%d]/page[%d]", index, i);
        ermXmlGetAttributeString(manifest, xpath, "url", url, MAX_LEN);
        ermXmlGetAttributeInt(manifest, xpath, "number", &count);   
        
        pItem->page[i - 1] = (PageInfo *)malloc(sizeof(PageInfo));             
        pItem->page[i - 1]->number = count;
        pItem->page[i - 1]->url = (char *)malloc(strnlen(url, MAX_LEN) + 1);
        strcpy(pItem->page[i - 1]->url, url);
        pItem->page[i - 1]->url[strlen(pItem->page[i - 1]->url)] = 0;
    }
    return pItem;
}

Here is the call graph for this function:

void pageListItem_release

(

PageListItem *

pItem

)

Definition at line 663 of file indexFileHandler.cpp.

{
    for(int i = 0; i < pItem->count; ++i)
    {
        // free memory used by each page fields and page itself
        pageInfo_release(pItem->page[i]);
        free(pItem->page[i]);
    }
    free(pItem->type);
    pItem->type = NULL;
    pItem->count = 0;
}

Here is the call graph for this function: