Sitecore Space - 사이트코어: ItemEditing

2017년 2월 6일 월요일

사이트코어 - 비활동중인 유저의 잠김 아이템을 풀림으로 설정하기 - Sitecore

일반 웹사이트들처럼 사이트코어 CMS는 Logout을 통하여 현재 로그인한 유저의 정보를 Session에서 삭제할수가 있다. 보통 유저들은 (나 역시,) CMS 작업 후, Logout 대신 브라우저의 X버튼을 누르면, 마치 로그아웃이 된 듯 CMS를 클로즈 한다. 여기에서 하나의 문제점이 있다.

사이트코어는 SessionID에 해당 유저가 여전히 존해하는것으로 알고, Idle 유저 또는 Inactive 유저로 인식한다. 고로, 해당 유저가 CMS 작업을 마친 후, 아이템 풀림을 설정하지 않고, 브라우저를 클로즈해버리면, 다른 유저들은 해당 아이템이 Unlock 될때가지 작업을 할수가 없다.

사이트코어의 기본적인 세팅으로, 아이템을 수정하기 위해서는 유저가 받드시 아이템 잠김상태를 하여, 다른 유저가 중복적으로 수정하지 못하도록 하여야 한다. 만일, 다른 유저가 잠김 상태의 아이템 수정을 필요로 하면, 잠금을 한 유저에게 풀림을 요청하던지, 아니면 관리자 (슈퍼 어드민) 에게 요청을 해야한다.

이런 불편함을 덜 하기위하여, 이번에 강제추방(?)의 클래스를 추가하였다.

아래의 코드는 사이트코어의 Session 정보를 받아들여 Session 정보에 들어있는 유저들의 마지막 활정 시간을 가져온다. DomainAccessGuard 클래스는 유저세션 정보를 가져오는 클래스로써, 만약 특정 유저의 마지막 활동이 현재 시간보다 55분 (config 파일 설정)이 초과하였을 경우, 해당의 유저가 잠금을 한 모든 아이템을 풀림으로 설정을 한다.

namespace YourNamespace.Unlock
{
    public class UnlockItemWhenIdle
    {
        private TimeSpan maximumIdleTime;

        public UnlockItemWhenIdle(string maximumIdleTime)
        {
            this.maximumIdleTime = TimeSpan.Parse(maximumIdleTime);
        }

        public void Run()
        {
            List<DomainAccessGuard.Session> userSessionList = DomainAccessGuard.Sessions;

            if (userSessionList != null && userSessionList.Count > 0)
            {
                foreach (DomainAccessGuard.Session userSession in userSessionList.ToArray())
                {
                    TimeSpan span = (TimeSpan)(DateTime.Now - userSession.LastRequest);

                    if (span > this.maximumIdleTime)
                    {
                        string currentUserName = userSession.UserName;

                        var database = Sitecore.Configuration.Factory.GetDatabase("master");
                        Item[] items = database.SelectItems("fast:/sitecore/content//*[@__lock='%" + currentUserName + "%']");
                        
                        foreach (var item in items)
                        {
                            item.Editing.BeginEdit();
                            item.Locking.Unlock();
                            item.Editing.EndEdit();
                        }
                    }
                }
            }
        }
    }
}

아래의 코드는 Maximum inactive 시간을 설정하는 config 파일이다. 새로운 .config 파일을 만들어도 되며, 또는 Sitecore.config 혹은 web.config 파일의 스케쥴 노드에 추가하면 된다. 필자는 `/Website/App_Config/Include/` 폴더에 `YourNamespace.Unlock.config` 파일을 만들었다. 스케쥴은 5분만다 한번씩 유저 정보를 체크하는것으로 되어있으며, 마지막 활동이 55분을 초과하면 강제추방이 작동하도록 설정을 하였다.

<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
    <sitecore>
        <scheduling>
            <!-- kick users who are idle for 55 minutes -->
            <agent type="YourNamespace.Unlock.UnlockItemWhenIdle, YourNamespace.Unlock" method="Run" interval="00:05:00">
                <param desc="maximumIdleTime">00:55:00</param>
            </agent>
        </scheduling>
    </sitecore>
</configuration>

2015년 7월 28일 화요일

템플릿 필드 업데이트 ItemEditing

#HowTo #Template

사이트코어를 사용하다 보면은 프로그램상으로 해당 페이지 또는 Sublayout/Rendering component의 템플릿 필드 값을 업데이트 해야하는 경우가 있다.

Sitecore.Data.Items.ItemEditing

아래의 코드는:

아이템 저장
업데이트 아이템 정보 (수정날짜, 에디터 및 통계정보)
아이템 저장과 관련된 이벤트를 실행한다

Sitecore.Data.Database master = Sitecore.Configuration.Factory.GetDatabase("master");
Sitecore.Data.Items.Item path = master.GetItem("/sitecore/content/the/path/you/want/to/get");

//Begin Editing Sitecore Item
path.Editing.BeginEdit();
try
{
    path["fieldName"] = "This is updated value";

    // This will commit the field value
    path.Editing.EndEdit();
}
catch (Exception)
{
    //Revert the Changes
    path.Editing.CancelEdit();
}

Sitecore.Data.Items.EditContext

아래의 코드는 윗 코드와 달리, 선택적으로 통계정보를 업데이트할수있으며, 또한 파라미터를 전달하는데 있어서 보안체크 또한 가능하다.

Sitecore.Data.Database master = Sitecore.Configuration.Factory.GetDatabase("master");
Sitecore.Data.Items.Item path = master.GetItem("/sitecore/content/the/path/you/want/to/get");

//Enable or disable statistics information
bool updateStatistics = false;  

//Temporary enable or disable events
bool silent = true;

//Begin Editing Sitecore Item
path.Editing.BeginEdit();
using (new EditContext(path, updateStatistics, silent))
{
    path["fieldName"] = "This is updated value";
}
path.Editing.EndEdit();

Sitecore.Data.Database master = Sitecore.Configuration.Factory.GetDatabase("master");
Sitecore.Data.Items.Item path = master.GetItem("/sitecore/content/the/path/you/want/to/get");

// Disable security check
path.Editing.BeginEdit();
using (new EditContext(path, SecurityCheck.Disable))  
{  
    path["fieldName"] = "This is updated value";  
}  
path.Editing.EndEdit();