summaryrefslogtreecommitdiffstats
path: root/mobile/android/base/java/org/mozilla/gecko/SessionParser.java
blob: d29aaadc73ddbdb8d0a37e7a6c21ccac7c332f1b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/* -*- Mode: Java; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
 * ***** BEGIN LICENSE BLOCK *****
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * ***** END LICENSE BLOCK ***** */

package org.mozilla.gecko;

import java.util.LinkedList;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import android.util.Log;

public abstract class SessionParser {
    private static final String LOGTAG = "GeckoSessionParser";

    public class SessionTab {
        final private String mTitle;
        final private String mUrl;
        final private JSONObject mTabObject;
        private boolean mIsSelected;

        private SessionTab(String title, String url, boolean isSelected, JSONObject tabObject) {
            mTitle = title;
            mUrl = url;
            mIsSelected = isSelected;
            mTabObject = tabObject;
        }

        public String getTitle() {
            return mTitle;
        }

        public String getUrl() {
            return mUrl;
        }

        public boolean isSelected() {
            return mIsSelected;
        }

        public JSONObject getTabObject() {
            return mTabObject;
        }

        /**
         * Is this tab pointing to about:home and does not contain any other history?
         */
        public boolean isAboutHomeWithoutHistory() {
            JSONArray entries = mTabObject.optJSONArray("entries");
            return entries != null && entries.length() == 1 && AboutPages.isAboutHome(mUrl);
        }
    };

    abstract public void onTabRead(SessionTab tab);

    /**
     * Placeholder method that must be overloaded to handle closedTabs while parsing session data.
     *
     * @param closedTabs, JSONArray of recently closed tab entries.
     * @throws JSONException
     */
    public void onClosedTabsRead(final JSONArray closedTabs) throws JSONException {
    }

    /**
     * Parses the provided session store data and calls onTabRead for each tab that has been found.
     *
     * @param sessionStrings One or more strings containing session store data.
     * @return False if any of the session strings provided didn't contain valid session store data.
     */
    public boolean parse(String... sessionStrings) {
        final LinkedList<SessionTab> sessionTabs = new LinkedList<SessionTab>();
        int totalCount = 0;
        int selectedIndex = -1;
        try {
            for (String sessionString : sessionStrings) {
                final JSONArray windowsArray = new JSONObject(sessionString).getJSONArray("windows");
                if (windowsArray.length() == 0) {
                    // Session json can be empty if the user has opted out of session restore.
                    Log.d(LOGTAG, "Session restore file is empty, no session entries found.");
                    continue;
                }

                final JSONObject window = windowsArray.getJSONObject(0);
                final JSONArray tabs = window.getJSONArray("tabs");
                final int optSelected = window.optInt("selected", -1);
                final JSONArray closedTabs = window.optJSONArray("closedTabs");
                if (closedTabs != null) {
                    onClosedTabsRead(closedTabs);
                }

                for (int i = 0; i < tabs.length(); i++) {
                    final JSONObject tab = tabs.getJSONObject(i);
                    final int index = tab.getInt("index");
                    final JSONArray entries = tab.getJSONArray("entries");
                    if (index < 1 || entries.length() < index) {
                        Log.w(LOGTAG, "Session entries and index don't agree.");
                        continue;
                    }
                    final JSONObject entry = entries.getJSONObject(index - 1);
                    final String url = entry.getString("url");

                    String title = entry.optString("title");
                    if (title.length() == 0) {
                        title = url;
                    }

                    totalCount++;
                    boolean selected = false;
                    if (optSelected == i + 1) {
                        selected = true;
                        selectedIndex = totalCount;
                    }
                    sessionTabs.add(new SessionTab(title, url, selected, tab));
                }
            }
        } catch (JSONException e) {
            Log.e(LOGTAG, "JSON error", e);
            return false;
        }

        // If no selected index was found, select the first tab.
        if (selectedIndex == -1 && sessionTabs.size() > 0) {
            sessionTabs.getFirst().mIsSelected = true;
        }

        for (SessionTab tab : sessionTabs) {
            onTabRead(tab);
        }

        return true;
    }
}