Magic Cube

///////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright 2020 Leszek Koltunski                                                               //

//                                                                                               //

// This file is part of Magic Cube.                                                              //

//                                                                                               //

// Magic Cube is free software: you can redistribute it and/or modify                            //

// it under the terms of the GNU General Public License as published by                          //

// the Free Software Foundation, either version 2 of the License, or                             //

// (at your option) any later version.                                                           //

//                                                                                               //

// Magic Cube is distributed in the hope that it will be useful,                                 //

// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //

// GNU General Public License for more details.                                                  //

//                                                                                               //

// You should have received a copy of the GNU General Public License                             //

// along with Magic Cube.  If not, see <http://www.gnu.org/licenses/>.                           //

///////////////////////////////////////////////////////////////////////////////////////////////////

package org.distorted.main;

import android.content.Context;

import android.content.SharedPreferences;

import android.content.res.Resources;

import android.os.Bundle;

import androidx.annotation.NonNull;

import com.google.android.play.core.review.ReviewInfo;

import com.google.android.play.core.review.ReviewManager;

import com.google.android.play.core.review.ReviewManagerFactory;

import com.google.android.play.core.tasks.OnCompleteListener;

import com.google.android.play.core.tasks.OnFailureListener;

import com.google.android.play.core.tasks.Task;

import com.google.firebase.analytics.FirebaseAnalytics;

import org.distorted.dialogs.RubikDialogNewRecord;

import org.distorted.dialogs.RubikDialogSolved;

import org.distorted.effects.BaseEffect;

import org.distorted.effects.EffectController;

import org.distorted.effects.scramble.ScrambleEffect;

import org.distorted.helpers.BlockController;

import org.distorted.helpers.MovesFinished;

import org.distorted.helpers.TwistyPreRender;

import org.distorted.objects.TwistyObject;

import org.distorted.objects.ObjectList;

import org.distorted.network.RubikScores;

import org.distorted.screens.RubikScreenPlay;

import org.distorted.screens.ScreenList;

import org.distorted.screens.RubikScreenSolving;

///////////////////////////////////////////////////////////////////////////////////////////////////

public class RubikPreRender implements EffectController, TwistyPreRender

  {

  private final RubikSurfaceView mView;

  private boolean mFinishRotation, mRemoveRotation, mRemovePatternRotation, mAddRotation,

                  mSetQuat, mChangeObject, mSetupObject, mSolveObject, mScrambleObject,

                  mInitializeObject, mSetTextureMap, mResetAllTextureMaps, mSolve;

  private boolean mUIBlocked, mTouchBlocked;

  private boolean mIsSolved;

  private ObjectList mNextObject;

  private int mNextSize;

  private long mRotationFinishedID;

  private final long[] mEffectID;

  private boolean mIsNewRecord;

  private long mNewRecord;

  private int mScreenWidth;

  private SharedPreferences mPreferences;

  private int[][] mNextMoves;

  private TwistyObject mOldObject, mNewObject;

  private int mScrambleObjectNum;

  private int mAddRotationAxis, mAddRotationRowBitmap, mAddRotationAngle;

  private long mAddRotationDuration;

  private MovesFinished mAddActionListener;

  private long mAddRotationID, mRemoveRotationID;

  private int mCubit, mFace, mNewColor;

  private int mNearestAngle;

  private String mDebug;

  private long mDebugStartTime;

  private final BlockController mBlockController;

///////////////////////////////////////////////////////////////////////////////////////////////////

  RubikPreRender(RubikSurfaceView view)

    {

    mView = view;

    mFinishRotation       = false;

    mRemoveRotation       = false;

    mRemovePatternRotation= false;

    mAddRotation          = false;

    mSetQuat              = false;

    mChangeObject         = false;

    mSetupObject          = false;

    mSolveObject          = false;

    mSolve                = false;

    mScrambleObject       = false;

    mOldObject = null;

    mNewObject = null;

    mScreenWidth = 0;

    mScrambleObjectNum = 0;

    mEffectID = new long[BaseEffect.Type.LENGTH];

    mDebug = "";

    RubikActivity act = (RubikActivity)mView.getContext();

    mBlockController = new BlockController(act);

    unblockEverything();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void createObjectNow(ObjectList object, int size, int[][] moves)

    {

    boolean firstTime = (mNewObject==null);

    if( mOldObject!=null ) mOldObject.releaseResources();

    mOldObject = mNewObject;

    Context con = mView.getContext();

    Resources res = con.getResources();

    mNewObject = object.create(size, mView.getQuat(), moves, res, mScreenWidth);

    if( mNewObject!=null )

      {

      mNewObject.createTexture();

      mView.setMovement(object.getObjectMovementClass());

      if( firstTime ) mNewObject.restorePreferences(mPreferences);

      if( mScreenWidth!=0 )

        {

        mNewObject.recomputeScaleFactor(mScreenWidth);

        }

      mIsSolved = mNewObject.isSolved();

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// do all 'adjustable' effects (SizeChange, Solve, Scramble)

  private void doEffectNow(BaseEffect.Type type)

    {

    try

      {

      int index = type.ordinal();

      mEffectID[index] = type.startEffect(mView.getRenderer().getScreen(),this);

      }

    catch( Exception ex )

      {

      android.util.Log.e("renderer", "exception starting effect: "+ex.getMessage());

      unblockEverything();

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void removeRotationNow()

    {

    mRemoveRotation=false;

    mNewObject.removeRotationNow();

    boolean solved = mNewObject.isSolved();

    if( solved && !mIsSolved )

      {

      if( ScreenList.getCurrentScreen()== ScreenList.SOLV )

        {

        RubikScreenSolving solving = (RubikScreenSolving) ScreenList.SOLV.getScreenClass();

        mNewRecord = solving.getRecord();

        if( mNewRecord< 0 )

          {

          mNewRecord = -mNewRecord;

          mIsNewRecord = false;

          }

        else

          {

          mIsNewRecord = true;

          }

        }

      unblockEverything();

      doEffectNow( BaseEffect.Type.WIN );

      }

    else

      {

      unblockEverything();

      }

    mIsSolved = solved;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void removeRotation()

    {

    mRemoveRotation = true;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void removePatternRotation()

    {

    mRemovePatternRotation = true;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void removePatternRotationNow()

    {

    mRemovePatternRotation=false;

    mNewObject.removeRotationNow();

    mAddActionListener.onActionFinished(mRemoveRotationID);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void addRotationNow()

    {

    mAddRotation = false;

    mAddRotationID = mNewObject.addNewRotation( mAddRotationAxis, mAddRotationRowBitmap,

                                                mAddRotationAngle, mAddRotationDuration, this);

    if( mAddRotationID==0 ) // failed to add effect - should never happen

      {

      unblockEverything();

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void finishRotationNow()

    {

    mFinishRotation = false;

    blockEverything(BlockController.RUBIK_PLACE_0);

    mRotationFinishedID = mNewObject.finishRotationNow(this, mNearestAngle);

    if( mRotationFinishedID==0 ) // failed to add effect - should never happen

      {

      unblockEverything();

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void changeObjectNow()

    {

    mChangeObject = false;

    if ( mNewObject==null || mNewObject.getObjectList()!=mNextObject || mNewObject.getNumLayers()!=mNextSize)

      {

      blockEverything(BlockController.RUBIK_PLACE_1);

      createObjectNow(mNextObject, mNextSize, null);

      doEffectNow( BaseEffect.Type.SIZECHANGE );

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setupObjectNow()

    {

    mSetupObject = false;

    if ( mNewObject==null || mNewObject.getObjectList()!=mNextObject || mNewObject.getNumLayers()!=mNextSize)

      {

      blockEverything(BlockController.RUBIK_PLACE_2);

      createObjectNow(mNextObject, mNextSize, mNextMoves);

      doEffectNow( BaseEffect.Type.SIZECHANGE );

      }

    else

      {

      mNewObject.initializeObject(mNextMoves);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void scrambleObjectNow()

    {

    mScrambleObject = false;

    mIsSolved       = false;

    blockEverything(BlockController.RUBIK_PLACE_3);

    RubikScores.getInstance().incrementNumPlays();

    doEffectNow( BaseEffect.Type.SCRAMBLE );

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void solveObjectNow()

    {

    mSolveObject = false;

    blockEverything(BlockController.RUBIK_PLACE_4);

    doEffectNow( BaseEffect.Type.SOLVE );

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void solveNow()

    {

    mSolve = false;

    mNewObject.solve();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void initializeObjectNow()

    {

    mInitializeObject = false;

    mNewObject.initializeObject(mNextMoves);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setTextureMapNow()

    {

    mSetTextureMap = false;

    if( mNewObject!=null ) mNewObject.setTextureMap(mCubit,mFace,mNewColor);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void resetAllTextureMapsNow()

    {

    mResetAllTextureMaps = false;

    if( mNewObject!=null ) mNewObject.resetAllTextureMaps();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void setQuatNow()

    {

    mSetQuat = false;

    mView.setQuat();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void reportRecord()

    {

    RubikScreenPlay play = (RubikScreenPlay) ScreenList.PLAY.getScreenClass();

    RubikScores scores = RubikScores.getInstance();

    int object      = play.getObject();

    int size        = play.getSize();

    int level       = play.getLevel();

    ObjectList list = ObjectList.getObject(object);

    String name     = scores.getName();

    String record = list.name()+"_"+size+" level "+level+" time "+mNewRecord+" isNew: "+mIsNewRecord+" scrambleNum: "+mScrambleObjectNum;

    if( BuildConfig.DEBUG )

       {

       android.util.Log.e("pre", mDebug);

       android.util.Log.e("pre", name);

       android.util.Log.e("pre", record);

       }

    else

      {

      final RubikActivity act = (RubikActivity)mView.getContext();

      FirebaseAnalytics analytics = act.getAnalytics();

      if( analytics!=null )

        {

        Bundle bundle = new Bundle();

        bundle.putString(FirebaseAnalytics.Param.CONTENT_TYPE, mDebug);

        bundle.putString(FirebaseAnalytics.Param.CHARACTER, name);

        bundle.putString(FirebaseAnalytics.Param.LEVEL, record);

        analytics.logEvent(FirebaseAnalytics.Event.LEVEL_UP, bundle);

        }

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void requestReview()

    {

    final RubikScores scores = RubikScores.getInstance();

    int numWins = scores.incrementNumWins();

    if( numWins==7 || numWins==30 || numWins==100 || numWins==200)

      {

      final long timeBegin = System.currentTimeMillis();

      final RubikActivity act = (RubikActivity)mView.getContext();

      final ReviewManager manager = ReviewManagerFactory.create(act);

      Task<ReviewInfo> request = manager.requestReviewFlow();

      request.addOnCompleteListener(new OnCompleteListener<ReviewInfo>()

        {

        @Override

        public void onComplete (@NonNull Task<ReviewInfo> task)

          {

          if (task.isSuccessful())

            {

            final String name = scores.getName();

            ReviewInfo reviewInfo = task.getResult();

            Task<Void> flow = manager.launchReviewFlow(act, reviewInfo);

            flow.addOnFailureListener(new OnFailureListener()

              {

              @Override

              public void onFailure(Exception e)

                {

                analyticsReport(act,"Failed", name, timeBegin);

                }

              });

            flow.addOnCompleteListener(new OnCompleteListener<Void>()

              {

              @Override

              public void onComplete(@NonNull Task<Void> task)

                {

                analyticsReport(act,"Complete", name, timeBegin);

                }

              });

            }

          else

            {

            String name = scores.getName();

            analyticsReport(act,"Not Successful", name, timeBegin);

            }

          }

        });

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void analyticsReport(RubikActivity act, String message, String name, long timeBegin)

    {

    long elapsed = System.currentTimeMillis() - timeBegin;

    String msg = message+" startTime: "+timeBegin+" elapsed: "+elapsed+" name: "+name;

    if( BuildConfig.DEBUG )

       {

       android.util.Log.d("pre", msg);

       }

    else

      {

      FirebaseAnalytics analytics = act.getAnalytics();

      if( analytics!=null )

        {

        Bundle bundle = new Bundle();

        bundle.putString(FirebaseAnalytics.Param.CONTENT_TYPE, msg);

        analytics.logEvent(FirebaseAnalytics.Event.SHARE, bundle);

        }

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

//

///////////////////////////////////////////////////////////////////////////////////////////////////

  void rememberMove(int axis, int row, int angle)

    {

    mDebug += (" (m "+axis+" "+(1<<row)+" "+angle+" "+(System.currentTimeMillis()-mDebugStartTime)+")");

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void setScreenSize(int width)

    {

    if( mNewObject!=null )

      {

      mNewObject.createTexture();

      mNewObject.recomputeScaleFactor(width);

      }

    mScreenWidth  = width;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void savePreferences(SharedPreferences.Editor editor)

    {

    if( mNewObject!=null )

      {

      mNewObject.savePreferences(editor);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void restorePreferences(SharedPreferences preferences)

    {

    mPreferences = preferences;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void finishRotation(int nearestAngle)

    {

    mNearestAngle   = nearestAngle;

    mFinishRotation = true;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void changeObject(ObjectList object, int size)

    {

    if( size>0 )

      {

      mChangeObject = true;

      mNextObject = object;

      mNextSize   = size;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void setupObject(ObjectList object, int size, int[][] moves)

    {

    if( size>0 )

      {

      mSetupObject= true;

      mNextObject = object;

      mNextSize   = size;

      mNextMoves  = moves;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void setTextureMap(int cubit, int face, int newColor)

    {

    mSetTextureMap = true;

    mCubit    = cubit;

    mFace     = face;

    mNewColor = newColor;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public boolean isTouchBlocked()

    {

    return mTouchBlocked;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public boolean isUINotBlocked()

    {

    return !mUIBlocked;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void blockEverything(int place)

    {

    mUIBlocked   = true;

    mTouchBlocked= true;

    mBlockController.touchBlocked(place);

    mBlockController.uiBlocked(place);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void blockTouch(int place)

    {

    mTouchBlocked= true;

    mBlockController.touchBlocked(place);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void unblockEverything()

    {

    mUIBlocked   = false;

    mTouchBlocked= false;

    mBlockController.touchUnblocked();

    mBlockController.uiUnblocked();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void unblockTouch()

    {

    mTouchBlocked= false;

    mBlockController.touchUnblocked();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void unblockUI()

    {

    mUIBlocked= false;

    mBlockController.uiUnblocked();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void setQuatOnNextRender()

    {

    mSetQuat = true;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  void preRender()

    {

    if( mSolve                 ) solveNow();

    if( mSetQuat               ) setQuatNow();

    if( mFinishRotation        ) finishRotationNow();

    if( mRemoveRotation        ) removeRotationNow();

    if( mRemovePatternRotation ) removePatternRotationNow();

    if( mChangeObject          ) changeObjectNow();

    if( mSetupObject           ) setupObjectNow();

    if( mSolveObject           ) solveObjectNow();

    if( mScrambleObject        ) scrambleObjectNow();

    if( mAddRotation           ) addRotationNow();

    if( mInitializeObject      ) initializeObjectNow();

    if( mResetAllTextureMaps   ) resetAllTextureMapsNow();

    if( mSetTextureMap         ) setTextureMapNow();

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// PUBLIC API

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void addRotation(MovesFinished listener, int axis, int rowBitmap, int angle, long duration)

    {

    mAddRotation = true;

    mAddActionListener    = listener;

    mAddRotationAxis      = axis;

    mAddRotationRowBitmap = rowBitmap;

    mAddRotationAngle     = angle;

    mAddRotationDuration  = duration;

    if( listener instanceof ScrambleEffect )

      {

      mDebug += (" (a "+axis+" "+rowBitmap+" "+angle+" "+(System.currentTimeMillis()-mDebugStartTime)+")");

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void initializeObject(int[][] moves)

    {

    mInitializeObject = true;

    mNextMoves = moves;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void scrambleObject(int num)

    {

    if( !mUIBlocked )

      {

      mScrambleObject = true;

      mScrambleObjectNum = num;

      mDebug = "";

      mDebugStartTime = System.currentTimeMillis();

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// this starts the Solve Effect

  public void solveObject()

    {

    if( !mUIBlocked )

      {

      mSolveObject = true;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// this only sets the cubits state to solved

  public void solve()

    {

    mSolve = true;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void resetAllTextureMaps()

    {

    mResetAllTextureMaps = true;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public TwistyObject getObject()

    {

    return mNewObject;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public TwistyObject getOldObject()

    {

    return mOldObject;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public int getNumScrambles()

    {

    return mScrambleObjectNum;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void effectFinished(final long effectID)

    {

    if( effectID == mRotationFinishedID )

      {

      mRotationFinishedID = 0;

      removeRotation();

      }

    else if( effectID == mAddRotationID )

      {

      mAddRotationID = 0;

      mRemoveRotationID = effectID;

      removePatternRotation();

      }

    else

      {

      for(int i=0; i<BaseEffect.Type.LENGTH; i++)

        {

        if( effectID == mEffectID[i] )

          {

          if( i!=BaseEffect.Type.WIN.ordinal() )

            {

            unblockEverything();

            }

          if( i==BaseEffect.Type.SCRAMBLE.ordinal() )

            {

            final RubikActivity act = (RubikActivity)mView.getContext();

            act.runOnUiThread(new Runnable()

              {

              @Override

              public void run()

                {

                ScreenList.switchScreen( act, ScreenList.READ);

                }

              });

            }

          if( i==BaseEffect.Type.WIN.ordinal() )

            {

            if( ScreenList.getCurrentScreen()== ScreenList.SOLV )

              {

              final RubikActivity act = (RubikActivity)mView.getContext();

              Bundle bundle = new Bundle();

              bundle.putLong("time", mNewRecord );

              reportRecord();

              requestReview();

              if( mIsNewRecord )

                {

                RubikDialogNewRecord dialog = new RubikDialogNewRecord();

                dialog.setArguments(bundle);

                dialog.show( act.getSupportFragmentManager(), RubikDialogNewRecord.getDialogTag() );

                }

              else

                {

                RubikDialogSolved dialog = new RubikDialogSolved();

                dialog.setArguments(bundle);

                dialog.show( act.getSupportFragmentManager(), RubikDialogSolved.getDialogTag() );

                }

              act.runOnUiThread(new Runnable()

                {

                @Override

                public void run()

                  {

                  ScreenList.switchScreen( act, ScreenList.DONE);

                  }

                });

              }

            }

          break;

          }

        }

      }

    }

  }