Display Plugin Settings Storage Sizes

[Wormopolis]

Plugin settings are capped at 64kb of storage.  this includes not only data you have added into the settings, but the settings setups themselves.

place this code in your global header or footer.  it will put a little orange plug down in the pbn-tray in the bottom right corner.  clicking the image will put up a dialog listing all of the plugins you have running and the storage space they take up.  the more important number is the "total settings size".  if that is approaching 64k, then you are going to start having issues.


<script type="text/javascript">
<!--
//  plugin settings size check
//  roughSizeOfObject function found on http://stackoverflow.com/questions/1248302/javascript-object-size
//  by Wormopolis
//  v1.01

function roughSizeOfObject( object ) {

   var objectList = [];
   var stack = [ object ];
   var bytes = 0;

   while ( stack.length ) {
       var value = stack.pop();
       if ( typeof value === 'boolean' ) {
           bytes += 4;
       }
       else if ( typeof value === 'string' ) {
           bytes += value.length * 2;
       }
       else if ( typeof value === 'number' ) {
           bytes += 8;
       }
       else if
       (
           typeof value === 'object'
           && objectList.indexOf( value ) === -1
       )
       {
           objectList.push( value );

           for( i in value ) {
               stack.push( value[ i ] );
           }
       }
   }
   return bytes;
}

function getSettingsSize() {
 var ret='';

 for(pn in proboards.plugin._plugins) {
   var totalSize=JSON.stringify(proboards.plugin._plugins[pn]).length;
   var getback=roughSizeOfObject(proboards.plugin._plugins[pn]);
   var kconvert1=parseInt((100*totalSize/1024))/100.0, kconvert2=parseInt(100*getback/1024)/100.0;
   ret+='<font size="3">name: '+pn+'</font><br><font style="margin-left:15px">total settings size: '+totalSize+' bytes ('+kconvert1+' kb)</font><br><font style="margin-left:15px">data size: '+getback+' bytes ('+kconvert2+' kb)</font><br><br>';
 }
 proboards.dialog("Plugin_Settings_Sizes", {
   html : ret,
   title : "Plugin Settings Sizes",
   hide: "puff",
   show: "fold",
   height : 500,
   width : 700,
   resizable : false,
   autoOpen : true
 });
}
$(document).ready(function(){
$('div#pbn-bar').css('width','auto').append($('<img src="http://i197./aa250/WORMOPOLIS/02920338-e74f-4011-83a6-7902a779b33f.jpg">').css({'display':'inline-block','margin-right':'2px'}).bind('click',getSettingsSize));

});
</script>


[Peter]

I know this is only meant to show a rough size, however it doesn't include the keys in the object does it?

i.e

var obj = {

key1: 1,
key2: 2,
key3: 3

};

You should push them into the stack to be counted as well.

[Wormopolis]

I didnt think of that.. or images.. Tim Camara do keys and images contribute to that 64k of storage?

[Peter]

Just in case we are talking about different things here, I wanted to clarify.

When I said "keys", I didn't mean the actual data keys, I meant the key in an object.

var obj = {

some_setting: 1,
some_setting2: "Hello World"

};

As for images, I would assume that would be included as well, since it would be part of the JSON string that gets stored. The function does add to the stack, but it only adds the value, not the key (string), which will greatly effect final byte size.

[Wormopolis]

yeah I knew what you meant. the key isnt up in the settings JSON though, its part of proboards.plugin.keys when it stores.

the "rough" function just mainly looks at memory usage the data the admin inputs into the plugin. its the "total settings size" that actually has more importance. since what I understood the 64k is the size of the JSON string that gets stored that is the most important, I made it seperate out the two. images and keys arent part of the setting string though, so I will write in something to scan them if they indeed apply towards that 64K. I dont think the image size would though, since 1. its stored in its own place on proboards servers, and 2. a lot of images are over 64K in size to begin with and dont seem to affect capacity.

[Wormopolis]

Tim Camara saw the first post but didnt see my question. do images and key permissions contribute to that 64k?

[Tim Camara]

Keys aren't, I think the only time images figure in is if you have an image selector in your UI. (and then, only to remember the selection that was made)

[Misaka]

curious would this code also tell you the exact amount of space you have left? 

[Tim Camara]

It will if you can do math. (64k - "total settings size")

[Misaka]

Aug 19, 2013 11:47:52 GMT -8 Tim Camara said:

It will if you can do math. (64k - "total settings size")

-_-"

math.... could there be a counter then?

[Wormopolis]

unless they plan on changing that 64K limit anytime, soon, just look at the total and see how close it is to 64K. its a fixed number.

[Tim Camara]

Just to chime in, I don't see that limit changing anytime soon.

[Misaka]

Aug 19, 2013 14:09:23 GMT -8 Wormopolis said:

unless they plan on changing that 64K limit anytime, soon, just look at the total and see how close it is to 64K. its a fixed number.

...
I'm pretty sure I'm way past that mark in terms to space maybe Tim Camara could double check for me?

[Wormopolis]

its 64K each plugin

[Misaka]

Aug 19, 2013 19:21:13 GMT -8 Wormopolis said:

its 64K each plugin

...

oh 

I thought it was combining all plugins