Merge lp:~openerp-dev/openerp-web/trunk-new-graphview-ged into lp:openerp-web

[Géry Debongnie]

Export functionality... Only code that changed is in addon web_graph (web)

[Xavier (Open ERP) (xmo-deactivatedaccount)]

* `if (result) { self.$('.graph_options_selection label').toggle(true); }` could be replaced by `self.$('.graph_options_selection label').toggle(result);` I think

* The Response object returned by make_response has a write-only `stream` attribute, so maybe (depending how complex workbook.save is) the StringIO dance could be replaced by:

    response = self.make_response(params)
    workbook.save(response.stream)
    return response

* maybe give a better name to the sheet e.g. the model name?

* `L` could probably benefit from comments to explain what it and its purpose are, maybe even a renaming. It seems to be used as a queue, but I'm not sure a queue of what. Also since it's a FIFO, should probably use collection.deque (.pop(0) is O(n) on a list, it's ~O(1) on deque, also it's called .popleft() which is clearer)

* in many worksheet.write() calls, there's a space missing after the first argument's comma, spacing also somewhat inconsistent in JS e.g. {width:nbr_measures, height:height, title: _t('Total'), id: pivot.cols.headers[0].id } some colons are followed by a space, others not

* maybe bold_style and non_bold_style should be renamed to header (or header_plain) and header_bold? Something like that? They seem to be header styles of sort (I may be wrong)

review: Needs Fixing

[lp:~openerp-dev/openerp-web/trunk-new-graphview-ged]

4119. By Géry Debongnie on 2014-02-05

[FIX] many small tweaks, add some comment, rename variables to have better more informative names in excel export functionality in graph view (addon web_graph)

[Géry Debongnie (gery-debongnie)]

The fixing has been done...

=== modified file 'addons/web_graph/__init__.py'
--- addons/web_graph/__init__.py	2012-10-23 15:26:46 +0000
+++ addons/web_graph/__init__.py	2014-02-05 13:14:23 +0000
@@ -0,0 +1,1 @@
+import controllers
 
=== added directory 'addons/web_graph/controllers'
=== added file 'addons/web_graph/controllers/__init__.py'
--- addons/web_graph/controllers/__init__.py	1970-01-01 00:00:00 +0000
+++ addons/web_graph/controllers/__init__.py	2014-02-05 13:14:23 +0000
@@ -0,0 +1,1 @@
+import main
 \ No newline at end of file
 
=== added file 'addons/web_graph/controllers/main.py'
--- addons/web_graph/controllers/main.py	1970-01-01 00:00:00 +0000
+++ addons/web_graph/controllers/main.py	2014-02-05 13:14:23 +0000
@@ -0,0 +1,88 @@
+from openerp import http
+import simplejson
+from openerp.http import request, serialize_exception as _serialize_exception
+from cStringIO import StringIO
+from collections import deque
+
+try:
+    import xlwt
+except ImportError:
+    xlwt = None
+
+class TableExporter(http.Controller):
+
+    @http.route('/web_graph/check_xlwt', type='json', auth='none')
+    def check_xlwt(self):
+        return xlwt is not None
+
+
+    @http.route('/web_graph/export_xls', type='http', auth="user")
+    def export_xls(self, data, token):
+        jdata = simplejson.loads(data)
+        nbr_measures = jdata['nbr_measures']
+        workbook = xlwt.Workbook()
+        worksheet = workbook.add_sheet(jdata['title'])
+        header_bold = xlwt.easyxf("font: bold on; pattern: pattern solid, fore_colour gray25;")
+        header_plain = xlwt.easyxf("pattern: pattern solid, fore_colour gray25;")
+        bold = xlwt.easyxf("font: bold on;")
+
+        # Step 1: writing headers
+        headers = jdata['headers']
+
+        # x,y: current coordinates 
+        # carry: queue containing cell information when a cell has a >= 2 height
+        #      and the drawing code needs to add empty cells below
+        x, y, carry = 1, 0, deque()  
+        for i, header_row in enumerate(headers):
+            worksheet.write(i,0, '', header_plain)
+            for header in header_row:
+                while (carry and carry[0]['x'] == x):
+                    cell = carry.popleft()
+                    for i in range(nbr_measures):
+                        worksheet.write(y, x+i, '', header_plain)
+                    if cell['height'] > 1:
+                        carry.append({'x': x, 'height':cell['height'] - 1})
+                    x = x + nbr_measures
+                style = header_plain if 'expanded' in header else header_bold
+                for i in range(header['width']):
+                    worksheet.write(y, x + i, header['title'] if i == 0 else '', style)
+                if header['height'] > 1:
+                    carry.append({'x': x, 'height':header['height'] - 1})
+                x = x + header['width'];
+            while (carry and carry[0]['x'] == x):
+                cell = carry.popleft()
+                for i in range(nbr_measures):
+                    worksheet.write(y, x+i, '', header_plain)
+                if cell['height'] > 1:
+                    carry.append({'x': x, 'height':cell['height'] - 1})
+                x = x + nbr_measures
+            x, y = 1, y + 1
+
+        # Step 2: measure row
+        if nbr_measures > 1:
+            worksheet.write(y,0, '', header_plain)
+            for measure in jdata['measure_row']:
+                style = header_bold if measure['is_bold'] else header_plain
+                worksheet.write(y, x, measure['text'], style);
+                x = x + 1
+            y = y + 1
+
+        # Step 3: writing data
+        x = 0
+        for row in jdata['rows']:
+            worksheet.write(y, x, row['indent'] * '     ' + row['title'], header_plain)
+            for cell in row['cells']:
+                x = x + 1
+                if cell.get('is_bold', False):
+                    worksheet.write(y, x, cell['value'], bold)
+                else:
+                    worksheet.write(y, x, cell['value'])
+            x, y = 0, y + 1
+
+        response = request.make_response(None,
+            headers=[('Content-Type', 'application/vnd.ms-excel'),
+                    ('Content-Disposition', 'attachment; filename=table.xls;')],
+            cookies={'fileToken': token})
+        workbook.save(response.stream)
+
+        return response
 
=== modified file 'addons/web_graph/static/src/js/graph_widget.js'
--- addons/web_graph/static/src/js/graph_widget.js	2014-01-28 15:11:13 +0000
+++ addons/web_graph/static/src/js/graph_widget.js	2014-02-05 13:14:23 +0000
@@ -25,6 +25,7 @@
         this.bar_ui = options.bar_ui || 'group';
         this.graph_view = options.graph_view || null;
         this.pivot_options = options;
+        this.title = options.title || 'Data';
     },
 
     start: function() {
@@ -39,6 +40,10 @@
             this.$('.graph_heatmap label').addClass('disabled');
         }
 
+        openerp.session.rpc('/web_graph/check_xlwt').then(function (result) {
+            self.$('.graph_options_selection label').toggle(result);
+        });
+
         return this.model.call('fields_get', []).then(function (f) {
             self.fields = f;
             self.fields.__count = {field:'__count', type: 'integer', string:_t('Quantity')};
@@ -85,8 +90,8 @@
             groupbys = _.flatten(_.map(filters, function (filter) {
                 var groupby = py.eval(filter.attrs.context).group_by;
                 if (!(groupby instanceof Array)) { groupby = [groupby]; }
-                return _.map(groupby, function(g) { 
-                    return {field: g, filter: filter}; 
+                return _.map(groupby, function(g) {
+                    return {field: g, filter: filter};
                 });
             }));
 
@@ -264,6 +269,9 @@
             case 'update_values':
                 this.pivot.update_data().then(this.proxy('display_data'));
                 break;
+            case 'export_data':
+                this.export_xls();
+                break;
         }
     },
 
@@ -356,13 +364,117 @@
     },
 
     // ----------------------------------------------------------------------
+    // Convert Pivot data structure into table structure :
+    //      compute rows, cols, colors, cell width, cell height, ...
+    // ----------------------------------------------------------------------
+    build_table: function() {
+        return {
+            headers: this.build_headers(),
+            measure_row: this.build_measure_row(),
+            rows: this.build_rows(),
+            nbr_measures: this.pivot.measures.length,
+            title: this.title,
+        };
+    },
+
+    build_headers: function () {
+        var pivot = this.pivot,
+            nbr_measures = pivot.measures.length,
+            height = _.max(_.map(pivot.cols.headers, function(g) {return g.path.length;})),
+            rows = [];
+
+        _.each(pivot.cols.headers, function (col) {
+            if (col.path.length === 0) { return;}
+            var cell_width = nbr_measures * (col.expanded ? pivot.get_ancestor_leaves(col).length : 1),
+                cell_height = col.expanded ? 1 : height - col.path.length + 1,
+                cell = {width: cell_width, height: cell_height, title: col.title, id: col.id, expanded: col.expanded};
+            if (rows[col.path.length - 1]) {
+                rows[col.path.length - 1].push(cell);
+            } else {
+                rows[col.path.length - 1] = [cell];
+            }
+        });
+
+        if (pivot.get_cols_leaves().length > 1) {
+            rows[0].push({width: nbr_measures, height: height, title: _t('Total'), id: pivot.main_col().id });
+        }
+        if (pivot.cols.headers.length === 1) {
+            rows = [[{width: nbr_measures, height: 1, title: _t('Total'), id: pivot.main_col().id, expanded: false}]];
+        }
+        return rows;
+    },
+
+    build_measure_row: function () {
+        var nbr_leaves = this.pivot.get_cols_leaves().length,
+            nbr_cols = nbr_leaves + ((nbr_leaves > 1) ? 1 : 0),
+            result = [],
+            add_total = this.pivot.get_cols_leaves().length > 1,
+            i, m;
+        for (i = 0; i < nbr_cols; i++) {
+            for (m = 0; m < this.pivot.measures.length; m++) {
+                result.push({
+                    text:this.pivot.measures[m].string,
+                    is_bold: add_total && (i === nbr_cols - 1)
+                });
+            }
+        }
+        return result;
+    },
+
+    make_cell: function (row, col, value, index) {
+        var formatted_value = openerp.web.format_value(value, {type:this.pivot.measures[index].type}),
+            cell = {value:formatted_value};
+
+        if (this.heatmap_mode === 'none') { return cell; }
+        var total = (this.heatmap_mode === 'both') ? this.pivot.get_total()[index]
+                  : (this.heatmap_mode === 'row')  ? this.pivot.get_total(row)[index]
+                  : this.pivot.get_total(col)[index];
+        var color = Math.floor(90 + 165*(total - Math.abs(value))/total);
+        if (color < 255) {
+            cell.color = color;
+        }
+        return cell;
+    },
+
+    build_rows: function () {
+        var self = this,
+            pivot = this.pivot,
+            m, cell;
+
+        return _.map(pivot.rows.headers, function (row) {
+            var cells = [];
+            _.each(pivot.get_cols_leaves(), function (col) {
+                var values = pivot.get_values(row.id,col.id);
+                for (m = 0; m < pivot.measures.length; m++) {
+                    cells.push(self.make_cell(row,col,values[m], m));
+                }
+            });
+            if (pivot.get_cols_leaves().length > 1) {
+                var totals = pivot.get_total(row);
+                for (m = 0; m < pivot.measures.length; m++) {
+                    cell = self.make_cell(row, pivot.main_col(), totals[m], m);
+                    cell.is_bold = 'true';
+                    cells.push(cell);
+                }
+            }
+            return {
+                id: row.id,
+                indent: row.path.length,
+                title: row.title,
+                expanded: row.expanded,
+                cells: cells,
+            };
+        });
+    },
+
+    // ----------------------------------------------------------------------
     // Main display method
     // ----------------------------------------------------------------------
     display_data: function () {
         this.$('.graph_main_content svg').remove();
         this.$('.graph_main_content div').remove();
         this.table.empty();
-        this.table.toggleClass('heatmap', this.heatmap_mode !== 'none')
+        this.table.toggleClass('heatmap', this.heatmap_mode !== 'none');
         this.width = this.$el.width();
         this.height = Math.min(Math.max(document.documentElement.clientHeight - 116 - 60, 250), Math.round(0.8*this.$el.width()));
 
@@ -384,159 +496,75 @@
     // Drawing the table
     // ----------------------------------------------------------------------
     draw_table: function () {
-        this.draw_top_headers();
-        _.each(this.pivot.rows.headers, this.proxy('draw_row'));
-    },
-
-    make_border_cell: function (colspan, rowspan, headercell) {
-        var tag = (headercell) ? $('<th>') : $('<td>');
-        return tag.addClass('graph_border')
-                             .attr('colspan', colspan || 1)
-                             .attr('rowspan', rowspan || 1);
-    },
-
-    make_header_title: function (header) {
-        return $('<span> ')
-            .addClass('web_graph_click')
-            .attr('href', '#')
-            .addClass((header.expanded) ? 'fa fa-minus-square' : 'fa fa-plus-square')
-            .text(' ' + (header.title || 'Undefined'));
-    },
-
-    draw_top_headers: function () {
-        var self = this,
-            thead = $('<thead>'),
-            pivot = this.pivot,
-            height = _.max(_.map(pivot.cols.headers, function(g) {return g.path.length;})),
-            header_cells = [[this.make_border_cell(1, height, true)]];
-
-        function set_dim (cols) {
-            _.each(cols.children, set_dim);
-            if (cols.children.length === 0) {
-                cols.height = height - cols.path.length + 1;
-                cols.width = 1;
-            } else {
-                cols.height = 1;
-                cols.width = _.reduce(cols.children, function (sum,c) { return sum + c.width;}, 0);
-            }
-        }
-
-        function make_col_header (col) {
-            var cell = self.make_border_cell(col.width*pivot.measures.length, col.height, true);
-            return cell.append(self.make_header_title(col).attr('data-id', col.id));
-        }
-
-        function make_cells (queue, level) {
-            var col = queue[0];
-            queue = _.rest(queue).concat(col.children);
-            if (col.path.length == level) {
-                _.last(header_cells).push(make_col_header(col));
-            } else {
-                level +=1;
-                header_cells.push([make_col_header(col)]);
-            }
-            if (queue.length !== 0) {
-                make_cells(queue, level);
-            }
-        }
-
-        set_dim(pivot.main_col());  // add width and height info to columns headers
-        if (pivot.main_col().children.length === 0) {
-            make_cells(pivot.cols.headers, 0);
+        var table = this.build_table();
+        this.draw_headers(table.headers);
+        this.draw_measure_row(table.measure_row);
+        this.draw_rows(table.rows);
+    },
+
+    make_header_cell: function (header) {
+        var cell = (_.has(header, 'cells') ? $('<td>') : $('<th>'))
+                        .addClass('graph_border')
+                        .attr('rowspan', header.height)
+                        .attr('colspan', header.width);
+        var content = $('<span>').addClass('web_graph_click')
+                                 .attr('href','#')
+                                 .text(' ' + (header.title || _t('Undefined')))
+                                 .attr('data-id', header.id);
+        if (_.has(header, 'expanded')) {
+            content.addClass(header.expanded ? 'fa fa-minus-square' : 'fa fa-plus-square');
         } else {
-            make_cells(pivot.main_col().children, 1);
-            if (pivot.get_cols_leaves().length > 1) {
-                header_cells[0].push(self.make_border_cell(pivot.measures.length, height, true).text(_t('Total')).css('font-weight', 'bold'));
-            }
-        }
-
-        _.each(header_cells, function (cells) {
-            thead.append($('<tr>').append(cells));
-        });
-        
-        if (pivot.measures.length >= 2) {
-            thead.append(self.make_measure_row());
-        }
-
-        self.table.append(thead);
-    },
-
-    make_measure_cells: function () {
-        return _.map(this.pivot.measures, function (measure) {
-            return $('<th>').addClass('measure_row').text(measure.string);
-        });
-    },
-
-    make_measure_row: function() {
-        var self = this,
-            cols = this.pivot.cols.headers,
-            measure_row = $('<tr>');
-
-        measure_row.append($('<th>'));
-
-        _.each(cols, function (col) {
-            if (!col.children.length) {
-                measure_row.append(self.make_measure_cells());
-            }
-        });
-
-        if (this.pivot.get_cols_leaves().length > 1) {
-            measure_row.append(self.make_measure_cells());
-        }
-        return measure_row;
-    },
-
-    draw_row: function (row) {
-        var self = this,
-            pivot = this.pivot,
-            measure_types = _.pluck(this.pivot.measures, 'type'),
-            html_row = $('<tr>'),
-            row_header = this.make_border_cell(1,1)
-                .append(this.make_header_title(row).attr('data-id', row.id))
-                .addClass('graph_border');
-
-        for (var i = 0; i < row.path.length; i++) {
-            row_header.prepend($('<span>', {class:'web_graph_indent'}));
-        }
-
-        html_row.append(row_header);
-
-        _.each(pivot.cols.headers, function (col) {
-            if (!col.children.length) {
-                var values = pivot.get_values(row.id, col.id);
-                for (var i = 0; i < values.length; i++) {
-                    html_row.append(make_cell(values[i], measure_types[i], i, col));
+            content.css('font-weight', 'bold');
+        }
+        if (_.has(header, 'indent')) {
+            for (var i = 0; i < header.indent; i++) { cell.prepend($('<span>', {class:'web_graph_indent'})); }
+        }
+        return cell.append(content);
+    },
+
+    draw_headers: function (headers) {
+        var make_cell = this.make_header_cell,
+            empty_cell = $('<th>').attr('rowspan', headers.length),
+            thead = $('<thead>');
+
+        _.each(headers, function (row) {
+            var html_row = $('<tr>');
+            _.each(row, function (header) {
+                html_row.append(make_cell(header));
+            });
+            thead.append(html_row);
+        });
+        thead.children(':first').prepend(empty_cell);
+        this.table.append(thead);
+    },
+    
+    draw_measure_row: function (measure_row) {
+        if (this.pivot.measures.length === 1) { return; }
+        var html_row = $('<tr>').append('<th>');
+        _.each(measure_row, function (cell) {
+            var measure_cell = $('<th>').addClass('measure_row').text(cell.text);
+            if (cell.is_bold) {measure_cell.css('font-weight', 'bold');}
+            html_row.append(measure_cell);
+        });
+        this.$('thead').append(html_row);
+    },
+    
+    draw_rows: function (rows) {
+        var table = this.table,
+            make_cell = this.make_header_cell;
+
+        _.each(rows, function (row) {
+            var html_row = $('<tr>').append(make_cell(row));
+            _.each(row.cells, function (cell) {
+                var html_cell = $('<td>').text(cell.value);
+                if (_.has(cell, 'color')) {
+                    html_cell.css('background-color', $.Color(255, cell.color, cell.color));
                 }
-            }
+                if (cell.is_bold) { html_cell.css('font-weight', 'bold'); }
+                html_row.append(html_cell);
+            });
+            table.append(html_row);
         });
-
-        if (pivot.get_cols_leaves().length > 1) {
-            var total_vals = pivot.get_total(row);
-            for (var j = 0; j < total_vals.length; j++) {
-                var cell = make_cell(total_vals[j], measure_types[j], j, pivot.cols[0]).css('font-weight', 'bold');
-                html_row.append(cell);
-            }
-        }
-
-        this.table.append(html_row);
-
-        function make_cell (value, measure_type, index, col) {
-            var cell = $('<td>');
-            if (value === undefined) {
-                return cell;
-            }
-            cell.text(openerp.web.format_value(value, {type: measure_type}));
-            var total = (self.heatmap_mode === 'both') ? pivot.get_total()[index]
-                  : (self.heatmap_mode === 'row')  ? pivot.get_total(row)[index]
-                  : (self.heatmap_mode === 'col')  ? pivot.get_total(col)[index]
-                  : undefined;
-
-            if (self.heatmap_mode !== 'none') {
-                var color = Math.floor(90 + 165*(total - Math.abs(value))/total);
-                cell.css('background-color', $.Color(255, color, color));
-            }
-            return cell;
-        }
     },
 
     // ----------------------------------------------------------------------
@@ -693,6 +721,20 @@
         });
     },
 
+    // ----------------------------------------------------------------------
+    // Controller stuff...
+    // ----------------------------------------------------------------------
+    export_xls: function() {
+        var c = openerp.webclient.crashmanager;
+        openerp.web.blockUI();
+        this.session.get_file({
+            url: '/web_graph/export_xls',
+            data: {data: JSON.stringify(this.build_table())},
+            complete: openerp.web.unblockUI,
+            error: c.rpc_error.bind(c)
+        });
+    },
+
 });
 
 // Utility function: returns true if the beginning of array2 is array1 and
 
=== modified file 'addons/web_graph/static/src/js/pivot_table.js'
--- addons/web_graph/static/src/js/pivot_table.js	2014-01-28 15:11:57 +0000
+++ addons/web_graph/static/src/js/pivot_table.js	2014-02-05 13:14:23 +0000
@@ -127,6 +127,10 @@
         return this._get_headers_with_depth(this.rows.headers, depth);
 	},
 
+    get_ancestor_leaves: function (header) {
+        return _.where(this.get_ancestors_and_self(header), {expanded:false});
+    },
+
 	// return all non expanded rows
 	get_rows_leaves: function () {
 		return _.where(this.rows.headers, {expanded:false});
 
=== modified file 'addons/web_graph/static/src/xml/web_graph.xml'
--- addons/web_graph/static/src/xml/web_graph.xml	2014-01-17 14:43:03 +0000
+++ addons/web_graph/static/src/xml/web_graph.xml	2014-02-05 13:14:23 +0000
@@ -41,6 +41,9 @@
             <label class="btn btn-default" data-choice="update_values" title="Reload Data">
                 <span class="fa fa-refresh"></span>
             </label>
+            <label class="btn btn-default" data-choice="export_data" title="Export Data" style="display:none">
+                <span class="fa fa-download"></span>
+            </label>
         </div>
         <div class="btn-group">
             <label class="btn btn-default dropdown-toggle" data-toggle="dropdown">