DataLogger.m

Go to the documentation of this file.

classdef DataLogger<mxberry.core.obj.StaticPropStorage
    
    methods (Static)
        function configure(varargin)
            
            import org.apache.log4j.Logger;
            className=mfilename('class');
            feval([className '.flush']);
            %% default values for properties
            storageLocation=[fileparts(which(className)) filesep 'DataLogs'];
            isEnabled=false;
            functionNameList=cell(1,0);
            nMaxDatesOnDisk=5;
            %% parse properties
            [~,prop]=mxberry.core.parseparams(varargin,[],0);
            nProp=length(prop);
            for iProp=1:2:nProp-1
                switch lower(prop{iProp})
                    case 'isenabled'
                        isEnabled=prop{iProp+1};
                    case 'functionnamelist'
                        functionNameList=prop{iProp+1};
                    case 'storagelocationroot'
                        storageLocation=prop{iProp+1};
                    case 'nmaxdatesondisk'
                        nMaxDatesOnDisk=prop{iProp+1};
                    otherwise
                        mxberry.core.throwerror('wrongInput',...
                            'Unknown property: %s',prop{iProp});
                end
            end
            %% check inputs
            % check isEnabled
            if ~(islogical(isEnabled)&&numel(isEnabled)==1)
                mxberry.core.throwerror('wrongInput',...
                    'isEnabled must be scalar logical');
            end
            % check functionNameList
            if ischar(functionNameList)
                if isempty(functionNameList)||size(functionNameList,2)~=...
                        numel(functionNameList)
                    mxberry.core.throwerror('wrongInput',...
                        'functionNameList must be nonempty string');
                end
                functionNameList={functionNameList};
            else
                isnWrong=iscell(functionNameList);
                if isnWrong
                    functionNameList=reshape(functionNameList,1,[]);
                    isnWrong=all(...
                        cellfun('isclass',functionNameList,'char')&...
                        cellfun('size',functionNameList,2)==...
                        cellfun('prodofsize',functionNameList)&...
                        ~cellfun('isempty',functionNameList));
                end
                if ~isnWrong
                    mxberry.core.throwerror('wrongInput',...
                        'functionNameList must be cell array with nonempty strings');
                end
                functionNameList=unique(functionNameList);
            end
            % check storageLocation
            if isempty(storageLocation)||~(ischar(storageLocation)&&...
                    size(storageLocation,2)==numel(storageLocation))
                mxberry.core.throwerror('wrongInput',...
                    'storageLocation must be nonempty string');
            end
            % check nMaxDatesOnDisk
            isnWrong=isnumeric(nMaxDatesOnDisk)&&numel(nMaxDatesOnDisk)==1;
            if isnWrong
                nMaxDatesOnDisk=double(nMaxDatesOnDisk);
                isnWrong=~isnan(nMaxDatesOnDisk)&&nMaxDatesOnDisk>=0&&...
                    floor(nMaxDatesOnDisk)==nMaxDatesOnDisk;
            end
            if ~isnWrong
                mxberry.core.throwerror('wrongInput',...
                    'nMaxDatesOnDisk must be scalar nonnegative integer');
            end
            %% preprocess data storage
            if ~mxberry.io.isdir(storageLocation)
                mxberry.io.mkdir(storageLocation);
            end
            if isfinite(nMaxDatesOnDisk)&&isEnabled
                % delete files that are more than nMaxDatesOnDisk dates on
                % disk
                SFileList=dir(storageLocation);
                SFileList([SFileList.isdir])=[];
                fileNameList={SFileList.name};
                if ~isempty(fileNameList)
                    [~,fileNameList,extNameList]=cellfun(@fileparts,...
                        fileNameList,'UniformOutput',false);
                    isFileVec=strcmp(extNameList,'.mat');
                    if any(isFileVec)
                        fileNameList=fileNameList(isFileVec);
                        fileNameList=fileNameList(...
                            [SFileList(isFileVec).datenum]<=...
                            addtodate(floor(now),-nMaxDatesOnDisk,'day'));
                        nFiles=numel(fileNameList);
                        if nFiles
                            fileNameList=strcat(storageLocation,filesep,fileNameList,'.mat');
                            for iFile=1:nFiles
                                delete(fileNameList{iFile});
                            end
                        end
                    end
                end
            end
            %% set properties
            setMethodName=[className '.setPropInternal'];
            feval(setMethodName,'isEnabled',isEnabled);
            feval(setMethodName,'functionNameList',functionNameList);
            feval(setMethodName,'prefixList',cell(1,0));
            feval(setMethodName,'loggerObj',Logger.getLogger(className));
            feval(setMethodName,'storageLocation',storageLocation);
            feval(setMethodName,'filePostfix',mxberry.system.getpidhost());
        end
        %
        function addPrefixToList(prefixStr)
            
            %% initial actions
            className=mfilename('class');
            if ~feval([className '.getIsEnabled'])
                return;
            end
            if isempty(prefixStr)||~(...
                    ischar(prefixStr)&&size(prefixStr,2)==numel(prefixStr))
                mxberry.core.throwerror('wrongInput',...
                    'prefixStr must be nonemtpy string');
            end
            %% add prefix
            prefixList=feval([className '.getPropInternal'],'prefixList');
            feval([className '.setPropInternal'],'prefixList',horzcat(prefixList,{prefixStr}));
        end
        %
        function removePrefixFromList()
            
            %% initial actions
            className=mfilename('class');
            if ~feval([className '.getIsEnabled'])
                return;
            end
            %% remove prefix
            prefixList=feval([className '.getPropInternal'],'prefixList');
            if isempty(prefixList)
                mxberry.core.throwerror('wrongObjState',...
                    'addPrefixToList must be called before calling this method');
            end
            feval([className '.setPropInternal'],'prefixList',prefixList(1:end-1));
        end
        %
        function log()
            
            className=mfilename('class');
            if ~feval([className '.getIsEnabled'])
                return;
            end
            [~,fullFuncName,isLogged]=feval([className '.getFunctionProps'],2);
            if ~isLogged
                return;
            end
            getMethodName=[className '.getPropInternal'];
            loggerObj=feval(getMethodName,'loggerObj');
            loggerObj.info([fullFuncName ' is performed']);
        end
        %
        function logData()
            
            className=mfilename('class');
            if ~feval([className '.getIsEnabled'])
                return;
            end
            [shortFuncName,fullFuncName,isLogged]=feval([className '.getFunctionProps'],2);
            if ~isLogged
                return;
            end
            loggerObj=feval([className '.getPropInternal'],'loggerObj');
            fileName=feval([className '.getDataFileName'],shortFuncName,fullFuncName);
            [~,shortFileName]=fileparts(fileName);
            loggerObj.info([fullFuncName ' is performed, data with local variables are in ' shortFileName]);
            evalin('caller',['save(' fileName ')']);
        end
        %
        function flush()
            
            className=mfilename('class');
            feval([className '.flushInternal'],className);
        end
    end
    
    methods (Access=protected,Static)
        function isEnabled=getIsEnabled()
            
            className=mfilename('class');
            [isEnabled,isConfigured]=feval([className '.getPropInternal'],...
                'isEnabled',true,className);
            isEnabled=isConfigured&&~isempty(isEnabled)&&isEnabled;
        end
        %
        function fileName=getDataFileName(shortFuncName,fullFuncName)
            
            className=mfilename('class');
            getMethodName=[className '.getPropInternal'];
            fileName=[feval(getMethodName,'storageLocation') filesep ...
                shortFuncName '_' feval(getMethodName,'filePostfix') '_'...
                datestr(now,30) '_' mxberry.core.hash(fullFuncName) '.mat'];
        end
        %
        function [shortFuncName,fullFuncName,isLogged]=getFunctionProps(indStack)
            import mxberry.core.cell.cell2tablestr;
            curClassName=mfilename('class');
            %% find function names (short and full one, but without
            %% prefixes)
            StFunc=dbstack('-completenames');
            nFuncs=numel(StFunc);
            isFound=false;
            isCheck=nargin==0;
            if isCheck
                indStack=3;
            else
                indStack=indStack+1;
            end
            for iFunc=indStack:nFuncs
                % determine name of class (if any) and name of
                % method (function or script)
                StFuncCur=StFunc(iFunc);
                [pathStr,fileName]=fileparts(StFuncCur.file);
                pathStr=strrep(pathStr,[filesep '+'],'.');
                indClass=strfind(pathStr,[filesep '@']);
                isClass=~isempty(indClass);
                if isClass
                    pathStr(indClass)='.';
                    pathStr(indClass+1)=[];
                end
                curInd=find(pathStr==filesep,1,'last');
                if ~isempty(curInd)
                    pathStr=pathStr(curInd+1:end);
                end
                curInd=find(pathStr=='.',1,'first');
                if isempty(curInd)
                    isPath=false;
                else
                    pathStr=pathStr(curInd+1:end);
                    isPath=~isempty(pathStr);
                end
                methodName=StFuncCur.name;
                curInd=find(methodName=='.',1,'first');
                if ~isempty(curInd)
                    methodName=methodName(curInd+1:end);
                    if ~isClass
                        pathStr=[pathStr '.' fileName]; %#ok<AGROW>
                        isClass=true;
                    end
                end
                shortFuncName=methodName(find(['/' methodName]=='/',1,'last'):end);
                className='';
                if isPath
                    if isClass
                        className=pathStr;
                    else
                        methodName=[pathStr '.' methodName]; %#ok<AGROW>
                    end
                end
                if isCheck
                    isFound=isempty(className);
                    if ~isFound
                        isFound=~any(strcmp(superclasses(className),curClassName));
                    end
                else
                    isFound=true;
                end
                if isFound
                    fullFuncName=methodName;
                    if ~isempty(className)
                        fullFuncName=[className '.' fullFuncName]; %#ok<AGROW>
                    end
                    break;
                end
            end
            if ~isFound
                mxberry.core.throwerror('wrongCall',[...
                    'This method must be called from function, script or '...
                    'method of some class different from descendants of %s'],...
                    mfilename('class'));
            end
            %% process fullFuncName and isLogged
            if nargout>1
                getMethodName=[curClassName '.getPropInternal'];
                prefixList=feval(getMethodName,'prefixList');
                fullFuncName=cell2tablestr([],[prefixList {fullFuncName}],'.');
                if nargout>2
                    isLogged=any(strcmp(fullFuncName,...
                        feval(getMethodName,'functionNameList')));
                end
            end
        end
        %
        function [propVal,isThere]=getPropInternal(propName,isPresenceChecked,className)
            
            if nargin>=3
                branchName=className;
            else
                branchName=mfilename('class');
            end
            if nargin<2
                isPresenceChecked=false;
            end
            [propVal,isThere]=mxberry.core.obj.StaticPropStorage.getPropInternal(...
                branchName,propName,isPresenceChecked);
        end
        %
        function setPropInternal(propName,propVal,className)
            
            if nargin>=3
                branchName=className;
            else
                branchName=mfilename('class');
            end
            mxberry.core.obj.StaticPropStorage.setPropInternal(...
                branchName,propName,propVal);
        end
    end
end