contentstorage/casrv/cawidgetscanner/inc/cawidgetstoragehandler.h
author hgs
Fri, 11 Jun 2010 16:13:51 +0300
changeset 98 d2f833ab7940
parent 96 5d243a69bdda
child 102 8b8b34fa9751
permissions -rw-r--r--
201023
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
85
7feec50967db 201003_02
hgs
parents:
diff changeset
     1
/*
98
hgs
parents: 96
diff changeset
     2
 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents: 96
diff changeset
     3
 * All rights reserved.
hgs
parents: 96
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents: 96
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents: 96
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents: 96
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
85
7feec50967db 201003_02
hgs
parents:
diff changeset
     8
 *
98
hgs
parents: 96
diff changeset
     9
 * Initial Contributors:
hgs
parents: 96
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents: 96
diff changeset
    11
 *
hgs
parents: 96
diff changeset
    12
 * Contributors:
hgs
parents: 96
diff changeset
    13
 *
hgs
parents: 96
diff changeset
    14
 * Description:
hgs
parents: 96
diff changeset
    15
 *
hgs
parents: 96
diff changeset
    16
 */
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    17
7feec50967db 201003_02
hgs
parents:
diff changeset
    18
#ifndef C_WIDGETSTORAGEHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#define C_WIDGETSTORAGEHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
class CCaStorageProxy;
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
class CCaWidgetDescription;
98
hgs
parents: 96
diff changeset
    23
class CCaWidgetScannerParser;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
//  INCLUDES
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
#include <e32base.h>
94
hgs
parents: 93
diff changeset
    27
#include <usif/scr/scr.h>
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
#include "cawidgetdescription.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
#include "castorage_global.h"
94
hgs
parents: 93
diff changeset
    30
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
// CONSTANTS
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
// FORWARD DECLARATIONS
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
 *  Widget Parser
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
 *  @since Series Series60 5.x
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
class CCaWidgetStorageHandler : public CBase
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
    {
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
public:
98
hgs
parents: 96
diff changeset
    43
CA_STORAGE_TEST_FRIEND_CLASS (T_CaWidgetScanner)
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
    // Constructors and destructor
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
     * Two-phased constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
     */
93
hgs
parents: 87
diff changeset
    51
    static CCaWidgetStorageHandler* NewL( CCaStorageProxy* aStorage,
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
            RFs& aFs );
93
hgs
parents: 87
diff changeset
    53
    static CCaWidgetStorageHandler* NewLC( CCaStorageProxy* aStorage,
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
            RFs& aFs );
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
     * Destructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
    virtual ~CCaWidgetStorageHandler();
93
hgs
parents: 87
diff changeset
    60
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
    /**
98
hgs
parents: 96
diff changeset
    62
     * SynchronizeL - synchronizes widgets on device with database
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
     */
98
hgs
parents: 96
diff changeset
    64
    void SynchronizeL();
93
hgs
parents: 87
diff changeset
    65
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
     * Adds widget to storage.
93
hgs
parents: 87
diff changeset
    70
     * @param aWidget widget to be added
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
     */
93
hgs
parents: 87
diff changeset
    72
    void AddL( const CCaWidgetDescription* aWidget );
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
     * Updates widget in storage.
93
hgs
parents: 87
diff changeset
    76
     * @param aWidget widget to be updated
98
hgs
parents: 96
diff changeset
    77
     * @param aEntryId entry of widget in db
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
     */
93
hgs
parents: 87
diff changeset
    79
    void UpdateL( const CCaWidgetDescription* aWidget, TUint aEntryId );
hgs
parents: 87
diff changeset
    80
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
     * Add/Updates widgets in DB
7feec50967db 201003_02
hgs
parents:
diff changeset
    83
     * @param aWidgets widgets to add
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    85
    void AddWidgetsL( const RWidgetArray& aWidgets );
93
hgs
parents: 87
diff changeset
    86
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    87
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
     * Removes widgets from DB
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
     */
98
hgs
parents: 96
diff changeset
    90
    void RemoveWidgetsL();
93
hgs
parents: 87
diff changeset
    91
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
     * Fetch widgets from content storage
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
     */
98
hgs
parents: 96
diff changeset
    95
    void FetchWidgetsL();
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    96
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    98
     * Add widget to download collection
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
     * @param aEntry entry containing widget information
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
    void AddWidgetToDownloadCollectionL( const CCaInnerEntry* aEntry );
93
hgs
parents: 87
diff changeset
   102
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   103
    /**
93
hgs
parents: 87
diff changeset
   104
     * Set missing flag for an entry.
hgs
parents: 87
diff changeset
   105
     * @param aWidget widget.
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
     */
93
hgs
parents: 87
diff changeset
   107
    void SetMissingFlagL( const CCaWidgetDescription * aWidget );
hgs
parents: 87
diff changeset
   108
hgs
parents: 87
diff changeset
   109
    /**
hgs
parents: 87
diff changeset
   110
     * Clear missing flag for an entry.
hgs
parents: 87
diff changeset
   111
     * @param aWidget widget.
hgs
parents: 87
diff changeset
   112
     */
hgs
parents: 87
diff changeset
   113
    void ClearVisibleFlagL( const CCaWidgetDescription* aWidget );
98
hgs
parents: 96
diff changeset
   114
96
hgs
parents: 94
diff changeset
   115
    /**
98
hgs
parents: 96
diff changeset
   116
     * Set localizations for widget in db
hgs
parents: 96
diff changeset
   117
     * @param aWidget widget.
hgs
parents: 96
diff changeset
   118
     * @param aEntryId of widget.
hgs
parents: 96
diff changeset
   119
     */
hgs
parents: 96
diff changeset
   120
    void SetLocalizationsL( const CCaWidgetDescription* aWidget, TInt aEntryId );
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
7feec50967db 201003_02
hgs
parents:
diff changeset
   122
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   123
7feec50967db 201003_02
hgs
parents:
diff changeset
   124
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   125
     * C++ default constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
   126
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   127
    CCaWidgetStorageHandler( CCaStorageProxy* aStorage, RFs& aFs );
7feec50967db 201003_02
hgs
parents:
diff changeset
   128
7feec50967db 201003_02
hgs
parents:
diff changeset
   129
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   130
     * By default Symbian 2nd phase constructor is private.
7feec50967db 201003_02
hgs
parents:
diff changeset
   131
     */
98
hgs
parents: 96
diff changeset
   132
    void ConstructL();
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   133
93
hgs
parents: 87
diff changeset
   134
    /**
hgs
parents: 87
diff changeset
   135
     * Check if mass storage is not in use.
hgs
parents: 87
diff changeset
   136
     * @return true if mass storage is not in use.
hgs
parents: 87
diff changeset
   137
     */
hgs
parents: 87
diff changeset
   138
    TBool MassStorageNotInUse();
hgs
parents: 87
diff changeset
   139
94
hgs
parents: 93
diff changeset
   140
    /**
hgs
parents: 93
diff changeset
   141
     * Adds or updates component id attribute in entry based on SCR provided data
hgs
parents: 93
diff changeset
   142
     * @param aPackageUid uid of the package which the widget represented by aEntry
hgs
parents: 93
diff changeset
   143
     * is delivered with
hgs
parents: 93
diff changeset
   144
     * @param aEntry widget entry being updated with component id attribute.
hgs
parents: 93
diff changeset
   145
     */
98
hgs
parents: 96
diff changeset
   146
    void UpdateComponentIdL( const TDesC& aManifestFilePathName,
hgs
parents: 96
diff changeset
   147
            CCaInnerEntry& aEntry ) const;
94
hgs
parents: 93
diff changeset
   148
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   149
private:
93
hgs
parents: 87
diff changeset
   150
    // Data
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   151
7feec50967db 201003_02
hgs
parents:
diff changeset
   152
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   153
     * Content Storage. Not Own
7feec50967db 201003_02
hgs
parents:
diff changeset
   154
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   155
    CCaStorageProxy* iStorage;
93
hgs
parents: 87
diff changeset
   156
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   157
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   158
     * File server. Not own
7feec50967db 201003_02
hgs
parents:
diff changeset
   159
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   160
    RFs iFs;
93
hgs
parents: 87
diff changeset
   161
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   162
    /*
7feec50967db 201003_02
hgs
parents:
diff changeset
   163
     * Widgets. Own.
7feec50967db 201003_02
hgs
parents:
diff changeset
   164
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   165
    RWidgetArray iWidgets;
93
hgs
parents: 87
diff changeset
   166
98
hgs
parents: 96
diff changeset
   167
    /**
hgs
parents: 96
diff changeset
   168
     * Pointer to a parser object. Own
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   169
     */
98
hgs
parents: 96
diff changeset
   170
    CCaWidgetScannerParser* iParser;
93
hgs
parents: 87
diff changeset
   171
94
hgs
parents: 93
diff changeset
   172
    Usif::RSoftwareComponentRegistry iSoftwareRegistry;
85
7feec50967db 201003_02
hgs
parents:
diff changeset
   173
    };
7feec50967db 201003_02
hgs
parents:
diff changeset
   174
7feec50967db 201003_02
hgs
parents:
diff changeset
   175
#endif      // C_WIDGETSTORAGEHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
   176
// End of File